[Python-ideas] Linking Doug's stdlib documentation to our main modules doc.

Carl M. Johnson cmjohnson.mailinglist at gmail.com
Sat Mar 19 09:41:32 CET 2011

On Fri, Mar 18, 2011 at 5:06 PM, Terry Reedy <tjreedy at udel.edu> wrote:

> I actually think that would be fine on wiki pages where any python writer
> can add links to their stuff. I already suggested that there could be one
> for module. There could also be some for statements and builtins.

It might be nice if at the bottom of the official docs there a link to
a wiki version of the docs and in the wiki version there were external
links to things like MOTW. Of course, the wiki would eventually have
links to resources that were OK but not great, but I don't think that
would be a problem as long as each page of the wiki has a link to its
equivalent in the official docs. The idea would be if I wanted to know
about module X, first I look in the official docs. If I find that my
question wasn't answered, or I just want more, I could switch over to
the wiki to see if anything different is over there and then check out
the list of external links.

I'm not sure if it would be maintainable or not, but would it be that
bad to try as an experiment? If after six months it doesn't seem to
have worked, take the link out of the official docs and shut the wiki
down. No harm in trying something out, right?

-- Carl Johnson

More information about the Python-ideas mailing list