Author belopolsky
Recipients belopolsky, docs@python, eric.araujo, georg.brandl, ron_adam
Date 2010-11-18.05:25:03
SpamBayes Score 4.21377e-06
Marked as misclassified No
Message-id <1290057906.13.0.370730628049.issue10446@psf.upfronthosting.co.za>
In-reply-to
Content
On Wed, Nov 17, 2010 at 11:21 PM, Ron Adam <report@bugs.python.org> wrote:
..
> I noticed in your patch, the disclaimer only prints when pydoc can find a doc location (docloc is not None).

This is not a disclaimer, but an explanation of the relationship
between pydoc pages and the reference manual.

> So it may not get displayed at all depending on how python is installed.

docloc should not be None for standard library modules.  This is a
separate issue.

>  I also think having it on every page may be a bit overly cautious. (IMHO)

In text viewer you only see one page at a time.  In HTML you may put
it on the index or start page.

> I'm also not sure it is correct to have that when viewing third party modules as the doc location
> in those cases will be broken anyway.
>
docloc is None for 3rd party modules (pydocs checks for site-packages
component in path).  The logic is not very robust, but that is a
separate issue.

> The obvious places to put it are:
>   * top of the pydoc html module index.  (first page displayed)
That's fine.

>   * in the welcome message for interactive help()
>   * help(help)
>   * help(pydoc)
>
No, these places are almost never seen.  Also, one should not think of
this as a disclaimer, but as an explanation of why she is shown a link
to a reference page when full documentation is already displayed.

> It can still be defined in one location and then use "+ pydoc_disclaimer" in the desired locations.

Sure.   Just don't call it "disclaimer".  Maybe Doc.REFTEXT constant
next to Doc.PYTHONDOCS?
History
Date User Action Args
2010-11-18 05:25:06belopolskysetrecipients: + belopolsky, georg.brandl, ron_adam, eric.araujo, docs@python
2010-11-18 05:25:06belopolskysetmessageid: <1290057906.13.0.370730628049.issue10446@psf.upfronthosting.co.za>
2010-11-18 05:25:03belopolskylinkissue10446 messages
2010-11-18 05:25:03belopolskycreate