[docs] [issue19980] Improve help('non-topic') response

Elias Zamaria report at bugs.python.org
Thu May 1 02:25:03 CEST 2014


Elias Zamaria added the comment:

Sorry for the late response but I have been busy with various things. I may
be able to work on this but I don't know when or how long it will take me.
I would suggest that someone else work on it if anyone wants it done any
time soon. I am sorry about this.

On Mon, Apr 14, 2014 at 7:43 AM, Jessica McKellar <report at bugs.python.org>wrote:

>
> Jessica McKellar added the comment:
>
> Elias, thanks for your patch!
>
> I think it's important to add the second part of Terry's suggestion which
> gives the user a specific next step to take, namely:
>
> > Try help('help') for information on recognized strings or help(str) for
> help on the str class.
>
> Can you add that to your patch?
>
> Additionally, we'll want to make sure we don't accidentally break this new
> functionality. Can you add a few test cases, for example what happens when
> you run help on a module (e.g. help("os"), 2) help on an instance of a
> class (e.g. help(1)), and help on a string that doesn't have a special
> meaning, (e.g. help("abcxyz"))?
>
> I don't see any existing tests for help(), but it is an instance of
> site._Helper (as reported by type(help)), and site tests live in
> Lib/test/test_site.py. It also gets loaded into builtins, so tests could
> also live in Lib/test/test_builtins.py.
>
> ----------
> nosy: +Jessica.McKellar, jesstess
>
> _______________________________________
> Python tracker <report at bugs.python.org>
> <http://bugs.python.org/issue19980>
> _______________________________________
>

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19980>
_______________________________________


More information about the docs mailing list