ENH: update describe_option to report default and current value

Author: y-p

RELEASE.rst

@@ -47,6 +47,7 @@ pandas 0.11.0
     preserve an all-nan object (e.g. strings)
   - Series print output now includes the dtype by default
   - Optimize internal reindexing routines for upcasting cases (#2819)
+  - ``describe_option()`` now reports the default and current value of options.
 
 **API Changes**
 

pandas/core/config.py

@@ -554,7 +554,11 @@ def _build_option_description(k):
 
     o = _get_registered_option(k)
     d = _get_deprecated_option(k)
+
     s = u'%s: ' % k
+    if o:
+        s += u'[default: %s] [currently: %s]' % (o.defval, _get_option(k, True))
+
     if o.doc:
         s += '\n' + '\n    '.join(o.doc.strip().split('\n'))
     else:

pandas/core/config_init.py

@@ -26,7 +26,7 @@
 
 pc_colspace_doc = """
 : int
-    Default space for DataFrame columns, defaults to 12
+    Default space for DataFrame columns.
 """
 
 pc_max_rows_doc = """
@@ -53,7 +53,7 @@
 
 pc_nb_repr_h_doc = """
 : boolean
-    When True (default), IPython notebook will use html representation for
+    When True, IPython notebook will use html representation for
     pandas objects (if it is available).
 """
 
@@ -69,13 +69,12 @@
 
 pc_pprint_nest_depth = """
 : int
-    Defaults to 3.
     Controls the number of nested levels to process when pretty-printing
 """
 
 pc_multi_sparse_doc = """
 : boolean
-    Default True, "sparsify" MultiIndex display (don't display repeated
+    "sparsify" MultiIndex display (don't display repeated
     elements in outer levels within groups)
 """
 
@@ -109,20 +108,17 @@
 
 pc_expand_repr_doc = """
 : boolean
-    Default False
     Whether to print out the full DataFrame repr for wide DataFrames
     across multiple lines.
     If False, the summary representation is shown.
 """
 
 pc_line_width_doc = """
 : int
-    Default 80
     When printing wide DataFrames, this is the width of each line.
 """
 pc_chop_threshold_doc = """
 : float or None
-    Default None
     if set to a float value, all float values smaller then the given threshold
     will be displayed as exactly 0 by repr and friends.
 """
@@ -156,7 +152,6 @@
 
 tc_sim_interactive_doc = """
 : boolean
-    Default False
     Whether to simulate interactive mode for purposes of testing
 """
 with cf.config_prefix('mode'):

pandas/tests/test_config.py

@@ -73,7 +73,8 @@ def test_describe_option(self):
         self.cf.register_option('c.d.e2', 1, 'doc4')
         self.cf.register_option('f', 1)
         self.cf.register_option('g.h', 1)
-        self.cf.deprecate_option('g.h', rkey="blah")
+        self.cf.register_option('k', 2)
+        self.cf.deprecate_option('g.h', rkey="k")
 
         # non-existent keys raise KeyError
         self.assertRaises(KeyError, self.cf.describe_option, 'no.such.key')
@@ -100,7 +101,7 @@ def test_describe_option(self):
         self.assertTrue(
             'precated' in self.cf.describe_option('g.h', _print_desc=False))
         self.assertTrue(
-            'blah' in self.cf.describe_option('g.h', _print_desc=False))
+            'k' in self.cf.describe_option('g.h', _print_desc=False))
 
     def test_case_insensitive(self):
         self.cf.register_option('KanBAN', 1, 'doc')