Merge pull request #1929 from jessedhillon/better-pshell-env-help

populate pshell's env_help with docstring of values

CONTRIBUTORS.txt

@@ -250,3 +250,5 @@ Contributors
 - Karen Dalton, 2015/06/01
 
 - Igor Stroh, 2015/06/10
+
+- Jesse Dhillon, 2015/10/07

pyramid/scripts/pshell.py

@@ -125,7 +125,10 @@ def run(self, shell=None):
             # remove any objects from default help that were overidden
             for k, v in env.items():
                 if k not in orig_env or env[k] != orig_env[k]:
-                    env_help[k] = v
+                    if getattr(v, '__doc__', False):
+                        env_help[k] = v.__doc__.replace("\n", " ")
+                    else:
+                        env_help[k] = v
 
         # load the pshell section of the ini file
         env.update(self.loaded_objects)

pyramid/tests/test_scripts/test_pshell.py

@@ -263,6 +263,7 @@ def test_command_setup(self):
         def setup(env):
             env['a'] = 1
             env['root'] = 'root override'
+            env['none'] = None
         self.config_factory.items = [('setup', setup)]
         shell = dummy.DummyShell()
         command.run(shell)
@@ -276,6 +277,7 @@ def setup(env):
             'request':self.bootstrap.request,
             'root_factory':self.bootstrap.root_factory,
             'a':1,
+            'none': None,
         })
         self.assertTrue(self.bootstrap.closer.called)
         self.assertTrue(shell.help)