Update settings doc (fixes
@@ -23,19 +23,18 @@ Here is a brief list of all currently available options.
* ``CONFIG``
* ``ENFORCE_KEYS_MONGO_COMPATIBLE`` *(default: True)*
- make sure all config keys are compatible with MongoDB
+ Make sure all config keys are compatible with MongoDB.
* ``ENFORCE_KEYS_JSONPICKLE_COMPATIBLE`` *(default: True)*
- make sure all config keys are serializable with jsonpickle
- * ``ENFORCE_KEYS_JSONPICKLE_COMPATIBLE`` *(default: True)*
- THIS IS IMPORTANT. Only deactivate if you know what you're doing.
+ Make sure all config keys are serializable with jsonpickle.
+ IMPORTANT: Only deactivate if you know what you're doing.
* ``ENFORCE_VALID_PYTHON_IDENTIFIER_KEYS`` *(default: False)*
- make sure all config keys are valid python identifiers
+ Make sure all config keys are valid python identifiers.
* ``ENFORCE_STRING_KEYS`` *(default: False)*
- make sure all config keys are strings
+ Make sure all config keys are strings.
* ``ENFORCE_KEYS_NO_EQUALS`` *(default: True)*
- make sure no config key contains an equals sign
+ Make sure no config key contains an equals sign.
* ``IGNORED_COMMENTS`` *(default: ['^pylint:', '^noinspection'])*
- list of regex patterns to filter out certain IDE or linter directives
+ List of regex patterns to filter out certain IDE or linter directives
from in-line comments in the documentation.
* ``READ_ONLY_CONFIG`` *(default: True)*
Make the configuration read-only inside of captured functions. This
@@ -54,8 +53,7 @@ Here is a brief list of all currently available options.
* ``COMMAND_LINE``
* ``STRICT_PARSING`` *(default: False)*
- disallow string fallback, if parsing a value from command-line failed.
+ Disallow string fallback if parsing a value from command-line failed.
This enforces the usage of quotes in the command-line. Note that this can
be very tedious since bash removes one set of quotes, such that double
quotes will be needed.
-
