Add docstring to gnuviechadmin.settings.base
This commit is contained in:
parent
cd696ceb1f
commit
9d843c920a
1 changed files with 6 additions and 2 deletions
|
@ -1,7 +1,9 @@
|
||||||
# -*- python -*-
|
# -*- python -*-
|
||||||
# pymode:lint_ignore=E501
|
# pymode:lint_ignore=E501
|
||||||
"""Common settings and globals."""
|
"""
|
||||||
|
Common settings and globals.
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
from os import environ
|
from os import environ
|
||||||
from os.path import abspath, basename, dirname, join, normpath
|
from os.path import abspath, basename, dirname, join, normpath
|
||||||
|
@ -18,7 +20,9 @@ def get_env_variable(var_name):
|
||||||
Get a setting from an environment variable.
|
Get a setting from an environment variable.
|
||||||
|
|
||||||
:param str var_name: variable name
|
:param str var_name: variable name
|
||||||
|
:raises ImproperlyConfigured: if the environment setting is not defined
|
||||||
|
:return: environment setting value
|
||||||
|
:rtype: str
|
||||||
"""
|
"""
|
||||||
try:
|
try:
|
||||||
return environ[var_name]
|
return environ[var_name]
|
||||||
|
|
Loading…
Reference in a new issue