]> granicus.if.org Git - python/commit
Improve documentation for PEP 370 support in site module (#8617).
authorÉric Araujo <merwok@netwok.org>
Fri, 19 Aug 2011 06:20:01 +0000 (08:20 +0200)
committerÉric Araujo <merwok@netwok.org>
Fri, 19 Aug 2011 06:20:01 +0000 (08:20 +0200)
commitafd2fe2aea94762a286c8cb5f758290c174d92fd
treef1c3e5c0e55da02e847751e8e61c99d5da2aa2cf
parente7329f47e777d75a6602418f3198589828c35fce
Improve documentation for PEP 370 support in site module (#8617).

site.USER_BASE and site.USER_SITE are now fully documented.  PEP 370 is
outdated with respects to the Mac framework situation, but the code in
sysconfig and the example in the 3.2 What’s New document helped me find
the right values to document for Mac OS X.

The command-line interface of the site module is also described in the
module docs.

The purpose of the usercustomize module is explained in the site docs,
with a gentle introduction in the tutorial (right after the section that
talks about PYTHONSTARTUP; a comment mentions it should be moved from
the tutorial to another file, but that will be another bug).

Various markup and wording improvements were made along the way in the
site module docs.  Duplicate and incomplete declarations of environment
variables have also been removed (the original bug report was actually
about these entries :).  The site module docs are still a bit messy;
I’ll see about improving them for #11553.

All these sections are copiously interlinked and findable from the doc
indexes.
Doc/library/site.rst
Doc/tutorial/interactive.rst
Doc/tutorial/interpreter.rst
Doc/using/cmdline.rst