Documentation suggestions

rurpy at yahoo.com rurpy at yahoo.com
Wed Dec 7 19:06:19 EST 2005


s... at pobox.com wrote:
> Ian> I think the point is that there is the core language, and from a
>     Ian> user's perspective builtins and statements and syntax are all the
>     Ian> same thing.  When you import a module, it's more-or-less obvious
>     Ian> where you find information about the module (the module index, of
>     Ian> course).
>
> I suspect I'd have a harder time living without the sys module than with
> many of the builtins.  Then there's os, re, math, ...  Some modules, like
> thread and sys, have to be linked into the interpreter.  Are they "core" or
> "add on"?  Once you start migrating stuff from the "add on" manual (Library
> Reference) to the "core" manual (Language Reference), where do you stop?

I think a natural dividing line is "import".  If you import it, it
is in the Library refrence.  If you don't, it is in the Language
reference.  The exception is sys, which could be
- documented fully in the Language ref. as an exception.
- documented as necessary in the Languge ref, and fully in
  the Library ref.

Thread would be documented in the Library reference because
- the fact that is is linked in the interpreter is invisable to me
  (the user).
- I have to do "import thread" to use it.

Sorry about the term "add-on".  I know that is the wrong
word, but couldn't think of anything better.




More information about the Python-list mailing list