Merge pull request #9499 from Carreau/document-raise-on-config

takluyver · takluyver · commit 1cdbfb28c382 · 2016-05-27T21:33:27.000+01:00
Document IPYTHON_SUPPRESS_CONFIG_ERRORS.
diff --git 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
 --------------------
