From 1cdbfb28c382eda899e1183c6877d4b759c6330a 2016-05-27 20:33:27 From: Thomas Kluyver Date: 2016-05-27 20:33:27 Subject: [PATCH] Merge pull request #9499 from Carreau/document-raise-on-config Document IPYTHON_SUPPRESS_CONFIG_ERRORS. --- diff --git a/docs/source/development/config.rst b/docs/source/development/config.rst index 39ec35c..c460e8d 100644 --- a/docs/source/development/config.rst +++ b/docs/source/development/config.rst @@ -55,6 +55,19 @@ under :file:`profile_default`. If you want the default config files for the :mod:`IPython.parallel` applications, add ``--parallel`` to the end of the command-line args. +.. note:: + + IPython configuration options are case sensitive, and IPython cannot + catch misnamed keys or invalid values. + + By default IPython will also ignore any invalid configuration files. + +.. versionadded:: 5.0 + + IPython can be configured to abort in case of invalid configuration file. + To do so set the environment variable ``IPYTHON_SUPPRESS_CONFIG_ERRORS`` to + `'1'` or `'true'` + Locating these files --------------------