[issue11553] Docs for: import, packages, site.py, .pth files

Change by Brett Cannon : -- nosy: -brett.cannon ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue11553] Docs for: import, packages, site.py, .pth files

Éric Araujo mer...@netwok.org added the comment: FYI, I have updated the site module and distutils/packaging docs to document the PEP 370 features. There has been no feedback, so I will backport to 2.7 and close the reports. See linked bugs to read the changesets. --

[issue11553] Docs for: import, packages, site.py, .pth files

aaugustin aymeric.augus...@polyconseil.fr added the comment: I noticed an inconsistency in the docs, and I think it falls in the Language Reference section of this ticket. In the definition of the import statement, after: | from module import * we should add: | from

[issue11553] Docs for: import, packages, site.py, .pth files

Éric Araujo mer...@netwok.org added the comment: Exactly what variants of arguments are possible, and what are their effects? Does http://docs.python.org/dev/library/functions#__import__ help? Does http://docs.python.org/dev/library/importlib ? Well somewhat overkill -- because the matter

[issue11553] Docs for: import, packages, site.py, .pth files

Nick Coghlan ncogh...@gmail.com added the comment: Ah, now I get your point re .pkg vs .pth. I naturally read that as .pth entries are to sys.path entries as .pkg entries are to pkg.__path__ entries, without any hint that those are the same *kind* of thing. However, I already know that

[issue11553] Docs for: import, packages, site.py, .pth files

Graham Wideman initcont...@grahamwideman.com added the comment: Hi Eric, Thanks for starting to review this, and your responses are encouraging. Some comments inline below. FWIW, along the way I accumulated my own notes on this topic, on some pages here: grahamwideman.wikispaces.com (Left

[issue11553] Docs for: import, packages, site.py, .pth files

Nick Coghlan ncogh...@gmail.com added the comment: Thanks for getting started with such a detailed review on this Graham. We've known the documentation in this area has been flawed for a long time, but actually *fixing* seemed like such a big task that it has tended to get pushed to the

[issue11553] Docs for: import, packages, site.py, .pth files

Changes by Greg Słodkowicz jerg...@gmail.com: -- nosy: +Greg.Slodkowicz ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue11553 ___ ___

[issue11553] Docs for: import, packages, site.py, .pth files

Graham Wideman initcont...@grahamwideman.com added the comment: Hi Nick: Thanks for your additional points. Comments inline: __all__ only affects import *, and may also affect documentation tools (e.g. pydoc will respect __all__ when deciding what to display). It has no effect on attribute

[issue11553] Docs for: import, packages, site.py, .pth files

Nick Coghlan ncogh...@gmail.com added the comment: Public name is a term that describes a convention, not anything enforced by the interpreter. Names starting with underscores typically aren't public either (unless documented otherwise), but that has no effect on the ability to retrieve them

[issue11553] Docs for: import, packages, site.py, .pth files

Graham Wideman initcont...@grahamwideman.com added the comment: Public name is a term that describes a convention, not anything enforced by the interpreter. And I guess that's really the main point. In other languages Public means accessible, and Private means not so. In Python, Public

[issue11553] Docs for: import, packages, site.py, .pth files

Éric Araujo mer...@netwok.org added the comment: Thanks for the detailed review. I’d like to work on a number of them. I think I’ll open focused bug reports and make this one depend on them; this will let interested people see the new bugs and possibly give feedback. The Language Reference

[issue11553] Docs for: import, packages, site.py, .pth files

Changes by Éric Araujo mer...@netwok.org: -- dependencies: +Better document user site-packages in site module doc, setup.py install --user option undocumented ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue11553

[issue11553] Docs for: import, packages, site.py, .pth files

Changes by Éric Araujo mer...@netwok.org: -- nosy: +brett.cannon, eric.araujo, ncoghlan, pje versions: +Python 2.7 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue11553 ___

[issue11553] Docs for: import, packages, site.py, .pth files

New submission from Graham Wideman initcont...@grahamwideman.com: The overall scope of this issue is that current Python documentation gives vague, sometimes incorrect, information about the set of Python features involved in modularizing functionality. This issue presents an obstacle to