Mailman 3 December 2010 - docs

[issue10559] NameError in tutorial/interpreter
by Georg Brandl Dec. 17, 2010

Dec. 17, 2010

Georg Brandl <georg(a)python.org> added the comment: "Use that list" doesn't make me happy, what about "access"? ---------- nosy: +georg.brandl _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10559> _______________________________________

1 0

[issue8040] It would be nice if documentation pages linked to other versions of the same document
by Éric Araujo Dec. 16, 2010

Dec. 16, 2010

Éric Araujo <merwok(a)netwok.org> added the comment: No, because with Subversion or Mercurial you’re free to clone/checkout any branch in a directory with an arbitrary name. For the py3k branch, Ezio’s checkout is named py3k but mine is 3.2, there is no way to put knowledge about that in the doc itself. ---------- nosy: +eric.araujo _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8040> _______________________________________

1 0

[issue8040] It would be nice if documentation pages linked to other versions of the same document
by Ezio Melotti Dec. 16, 2010

Dec. 16, 2010

Ezio Melotti <ezio.melotti(a)gmail.com> added the comment: If you want to work on this you should also consider that the URLs used on docs.python.org don't necessary match the directory structure present when building the doc locally. For example here it would be: .../py3k/library/fractions.html .../release31-maint/library/fractions.html .../release27-maint/library/fractions.html .../release26-maint/library/fractions.html This could be addressed with a config file that is not kept under version control (and possibly with default values used when this file is not present). ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8040> _______________________________________

2 1

[issue10669] Document Deprecation Warnings and how to fix
by Éric Araujo Dec. 16, 2010

Dec. 16, 2010

Changes by Éric Araujo <merwok(a)netwok.org>: ---------- components: -2to3 (2.x to 3.0 conversion tool) _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10669> _______________________________________

1 0

[issue10669] Document Deprecation Warnings and how to fix
by Éric Araujo Dec. 16, 2010

Dec. 16, 2010

Éric Araujo <merwok(a)netwok.org> added the comment: PEP 4 and PEP 290 are related to this subject, but not comprehensive, not on docs.python.org, and not tutorial-like. I think we could try Ezio’s idea. Sphinx can produce a document containing only version* directives (“make changes”). If such a document is clear enough and has links to the longer docs, there would be no need to write separate howtos. ---------- nosy: +eric.araujo _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10669> _______________________________________

1 0

[issue10669] Document Deprecation Warnings and how to fix
by Raymond Hettinger Dec. 16, 2010

Dec. 16, 2010

Raymond Hettinger <rhettinger(a)users.sourceforge.net> added the comment: FWIW, whatsnew is not primary documentation -- it should not be the sole or central source of anything except a highlevel overview and examples for the author's choice of selected version differences to highlight. A howto document would work best as a central place to list all deprecations and advice on what to do about them. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10669> _______________________________________

1 0

[issue10609] dbm documentation example doesn't work (iteritems())
by Éric Araujo Dec. 15, 2010

Dec. 15, 2010

Éric Araujo <merwok(a)netwok.org> added the comment: IMO, wrapping db in a dict defeats the purpose of dbm implementing a mapping interface. I would use the most natural mapping idioms: - for k, v in db.iteritems(): - print(k, '\t', v) + for k in db: + print(k, '\t', db[k]) The downside of this example is that it does not explicitely call methods, making the comment about “Other dictionary methods” strange. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10609> _______________________________________

1 0

[issue10559] NameError in tutorial/interpreter
by Éric Araujo Dec. 15, 2010

Dec. 15, 2010

Éric Araujo <merwok(a)netwok.org> added the comment: New wording: When known to the interpreter, the script name and additional arguments thereafter are passed to the script in the variable ``sys.argv``, which is a -list of strings. Its length is at least one; when no script and no arguments +list of strings. You have to execute ``import sys`` before you can use that +list. Its length is at least one; when no script and no arguments are given, ``sys.argv[0]`` is an empty string. When the script name is given as ``'-'`` (meaning standard input), ``sys.argv[0]`` is set to ``'-'``. When :option:`-c` *command* is used, ``sys.argv[0]`` is set to ``'-c'``. When ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10559> _______________________________________

1 0

[issue8851] pkgutil document needs more markups
by MATSUI Tetsushi Dec. 15, 2010

Dec. 15, 2010

New submission from MATSUI Tetsushi <mft(a)users.sourceforge.net>: The library reference of pkgutil is only sparsely marked up. The attached patch is against 2.6 version, because I'm currently working with 2.6. Since a part of markups (namely :pep:'s) has already been done for 3.2 version, the patch cannot be applied directly to that version, and I haven't checked the versions in between. ---------- assignee: docs@python components: Documentation files: pkgutil.diff keywords: patch messages: 106708 nosy: docs@python, mft priority: normal severity: normal status: open title: pkgutil document needs more markups versions: Python 2.6 Added file: http://bugs.python.org/file17492/pkgutil.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8851> _______________________________________

2 3

[issue10693] error in documentation of distutils.archive_util.make_zipfile
by Eli Bendersky Dec. 15, 2010

Dec. 15, 2010

New submission from Eli Bendersky <eliben(a)gmail.com>: The documentation of: distutils.archive_util.make_zipfile(base_name, base_dir[, verbose=0, dry_run=0]) Says: Create a zip file from all files in and under base_dir. The output zip file will be named base_dir + .zip. This isn't correct, as the name of the output file is "base_name + .zip" The error exists both in the docstring of make_zipfile in distutils/archive_util.py and in the ReST documentation of the function ---------- assignee: tarek components: Distutils, Documentation keywords: easy messages: 123872 nosy: docs@python, eli.bendersky, eric.araujo, tarek priority: normal severity: normal status: open title: error in documentation of distutils.archive_util.make_zipfile versions: Python 2.6, Python 2.7, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10693> _______________________________________

2 2