Add docstring to gnuviechadmin.settings.base

This commit is contained in:
Jan Dittberner 2016-01-31 16:37:06 +01:00
parent cd696ceb1f
commit 9d843c920a

View file

@ -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]