[issue8617] Non-existent variables documented
New submission from Dave Abrahams dave@boostpro.com:
http://docs.python.org/library/site.html#module-site mentions two variables that don't appear in my Python 2.6.5 installation's site module:
PYTHONNOUSERSITE New in version 2.6.
PYTHONUSERBASE New in version 2.6.
---------- assignee: docs@python components: Documentation messages: 104985 nosy: dabrahams, docs@python priority: normal severity: normal status: open title: Non-existent variables documented versions: Python 2.6
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue8617 _______________________________________
R. David Murray rdmurray@bitdance.com added the comment:
These are references to environment variables. The markup marks them as such, but this does not translate into HTML in a visible way. Without a text description it is also left to guesswork as to how they function. The 2.7 docs are even more confusing, adding 'getuserbase'. Adding Tarek as nosy since he has been updating this doc most recently.
---------- nosy: +r.david.murray, tarek stage: -> needs patch type: -> behavior versions: +Python 2.7, Python 3.1, Python 3.2
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue8617 _______________________________________
Tarek Ziadé ziade.tarek@gmail.com added the comment:
site definitely needs more documentation about the per-user site-packages.
We need to add a section about that. I am adding Christian to the nosy list, since he added those feature. I can work on a section sometimes next week and propose a patch here btw.
---------- nosy: +christian.heimes
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue8617 _______________________________________
Éric Araujo merwok@netwok.org added the comment:
Tarek, if you don’t have time for a patch, I am interested in making one.
---------- nosy: +eric.araujo title: Non-existent variables documented -> Better document user site-packages in site module doc versions: +Python 3.3 -Python 2.6
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue8617 _______________________________________
Éric Araujo merwok@netwok.org added the comment:
I have started to work on this; I’ll have one or two patches ready in a few weeks.
---------- assignee: docs@python -> eric.araujo versions: -Python 3.1
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue8617 _______________________________________
Changes by Éric Araujo merwok@netwok.org:
---------- keywords: +patch Added file: http://bugs.python.org/file22498/pep370-doc.diff
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue8617 _______________________________________
Changes by Éric Araujo merwok@netwok.org:
---------- keywords: +needs review stage: needs patch -> patch review
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue8617 _______________________________________
Roundup Robot devnull@psf.upfronthosting.co.za added the comment:
New changeset 74179a79d673 by Éric Araujo in branch '3.2': Improve documentation for PEP 370 support in site module (#8617). http://hg.python.org/cpython/rev/74179a79d673
New changeset d354802a637d by Éric Araujo in branch 'default': Merge doc changes from 3.2 (#8617, #10745). http://hg.python.org/cpython/rev/d354802a637d
---------- nosy: +python-dev
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue8617 _______________________________________
Roundup Robot devnull@psf.upfronthosting.co.za added the comment:
New changeset b3f72b6450f1 by Éric Araujo in branch '2.7': Improve documentation for PEP 370 support in site module (#8617). http://hg.python.org/cpython/rev/b3f72b6450f1
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue8617 _______________________________________
Changes by Éric Araujo merwok@netwok.org:
---------- resolution: -> fixed stage: patch review -> committed/rejected status: open -> closed
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue8617 _______________________________________
Maxim Doucet maxim.doucet@gmail.com added the comment:
Shouldn't there be an update of the 2.6 documentation too?
After your patch, the 2.7 reflects the existence of the "--user" option (see http://docs.python.org/release/2.7.3/install/index.html#alternate-installati...) but not the 2.6 documentation (http://docs.python.org/release/2.6.8/install/index.html#alternate-installati...).
In my personal experience, I used the "--home" option with python 2.6 to mimic what "--user" does and it took me 2 weeks to, by chance, stumble upon http://www.python.org/dev/peps/pep-0370/ which informed me that the "--user" option was originally available for python 2.6. If it had been on the 2.6 documentation, it would have been easier and more coherent IMHO.
---------- nosy: +maximd
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue8617 _______________________________________
Éric Araujo merwok@netwok.org added the comment:
2.6 only gets security fixes now.
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue8617 _______________________________________
Éric Araujo merwok@netwok.org added the comment:
BTW it appears that many people use the most recent 2.7 documentation even if they are using 2.6, because the doc is better and there are notes which tell you if something was changed or added in 2.7. For PEP 370 there are notes in the doc of the site module and the environment variables but I forgot to add one to the distutils doc; I will do that.
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue8617 _______________________________________
Maxim Doucet maxim.doucet@gmail.com added the comment:
Fair enough, thank you for the information. As a side note, my original question was in fact more suited for issue10745
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue8617 _______________________________________
participants (6)
-
Dave Abrahams -
Maxim Doucet
-
R. David Murray
-
Roundup Robot
-
Tarek Ziadé
-
Éric Araujo