diff --git a/docs/values.rst b/docs/values.rst index 61eca25..d7b10b8 100644 --- a/docs/values.rst +++ b/docs/values.rst @@ -160,12 +160,12 @@ the prefix. :param default: the default value of the setting :param environ: toggle for environment use - :param environ_name: name of environment variable to look for - :param environ_prefix: prefix to use when looking for environment variable + :param environ_name: capitalized name of environment variable to look for + :param environ_prefix: capitalized prefix to use when looking for environment variable :param environ_required: whether or not the value is required to be set as an environment variable :type environ: bool - :type environ_name: capitalized string or None - :type environ_prefix: capitalized string + :type environ_name: str or None + :type environ_prefix: str :type environ_required: bool The ``default`` parameter is effectively the value the setting has @@ -256,6 +256,10 @@ Type values MYSITE_CONVERSION_RATE = values.DecimalValue(decimal.Decimal('4.56214')) +.. class:: SequenceValue + + Common base class for sequence values. + .. class:: ListValue(default, [separator=',', converter=None]) A :class:`~SequenceValue` subclass that handles list values. @@ -301,6 +305,10 @@ Type values See the :class:`~ListValue` examples above. +.. class:: SingleNestedSequenceValue + + Common base class for nested sequence values. + .. class:: SingleNestedTupleValue(default, [seq_separator=';', separator=',', converter=None]) A :class:`~SingleNestedSequenceValue` subclass that handles single nested tuple values, @@ -353,9 +361,9 @@ Type values DEPARTMENTS = values.DictValue({ 'it': ['Mike', 'Joe'], }) - + Override using environment variables like this:: - + DJANGO_DEPARTMENTS={'it':['Mike','Joe'],'hr':['Emma','Olivia']} Validator values @@ -588,7 +596,7 @@ Value mixins requires a ``caster`` class attribute of one of the following types: - dotted import path, e.g. ``'mysite.utils.custom_caster'`` - - a callable, e.g. :func:`int` + - a callable, e.g. :class:`int` Example:: @@ -609,7 +617,7 @@ Value mixins validation attempt. - dotted import path, e.g. ``'mysite.validators.custom_validator'`` - - a callable, e.g. :func:`bool` + - a callable, e.g. :class:`bool` Example::