Mailman 3 August 2013 - docs

[issue17701] Improving strftime documentation
by David Wolever Aug. 12, 2013

Aug. 12, 2013

New submission from David Wolever: The current strftime documentation isn't very helpful. It doesn't have examples, and the ordering is unhelpful. I've also moved some format-specific notes into the notes below the format-string-table, because the format string table is what 98%* of people care about. TODO before this can be merged: - Clean up note order - Check that it works with the Python 3 docs *: based on a sample size of 1 ---------- assignee: docs@python components: Documentation files: strftime-docs.diff keywords: needs review, patch messages: 186601 nosy: docs@python, wolever priority: normal severity: normal status: open title: Improving strftime documentation type: enhancement versions: Python 2.7 Added file: http://bugs.python.org/file29784/strftime-docs.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17701> _______________________________________

4 18

[issue12645] test.support. import_fresh_module - incorrect doc
by Eli Bendersky Aug. 11, 2013

Aug. 11, 2013

New submission from Eli Bendersky <eliben(a)gmail.com>: >From Ezio Melotti's email to python-dev: diff --git a/Doc/library/test.rst b/Doc/library/test.rst --- a/Doc/library/test.rst +++ b/Doc/library/test.rst @@ -447,7 +447,7 @@ Module and package deprecation messages are suppressed during this import if *deprecated* is ``True``. - This function will raise :exc:`unittest.SkipTest` is the named module + This function will raise :exc:`unittest.SkipTest` if the named module Actually I think this is no longer true. import_fresh_module raises an ImportError if *name* can't be imported, or returns None if the fresh module is not found. Its use case is to enable or block accelerations for modules that optionally provide one. All the modules that currently use import_fresh_module are (afaik) always available (json, warnings, heapq), so raising SkipTest when the module is missing is not useful now. It returns None in the case an acceleration is missing, so e.g. in "cjson = import_fresh_module('json', fresh=['_json'])" cjson will be None and it will be possible to do things like @skipUnless(cjson, 'requires _json'). Here raising an ImportError will defeat (part of) the purpose of the function, i.e. avoiding: try: import _json except ImportError: _json = None and raising a SkipTest when the accelerations are missing is not an option if there are other tests (e.g. the tests for the Python implementation). These changes come from http://hg.python.org/cpython/rev/c1a12a308c5b . Before the change import_fresh_module was still returning the module (e.g. json) even when the acceleration (fresh=['_json']) was missing, and the C tests were run twice using the same pure-python module used for the Py ones. The typo and the wrong doc is also on 2.7. ---------- assignee: docs@python components: Documentation keywords: easy messages: 141255 nosy: docs@python, eli.bendersky, ezio.melotti priority: normal severity: normal status: open title: test.support. import_fresh_module - incorrect doc versions: Python 2.7, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue12645> _______________________________________

5 9

I want to report a error on python tutorial
by jean Lopes Aug. 11, 2013

Aug. 11, 2013

Hello manager of python documentation, I want to report a little error on tutorial. Follows the links: http://docs.python.org/2/tutorial/datastructures.html#using-lists-as-stacks http://docs.python.org/2/tutorial/datastructures.html#using-lists-as-queues Just there is a small exchange in the explain of stacks and queues. I hope to have helped. -- -- Att, *Jean Lopes* Desenvolvedor .NET @ www.RedeHost.com.br <http://www.redehost.com.br/> Telefone: (51) 8149.8684

1 0

Document codecs.encode and codecs.decode (issue 17827)
by ezio.melotti＠gmail.com Aug. 11, 2013

Aug. 11, 2013

http://bugs.python.org/review/17827/diff/8606/Doc/library/codecs.rst File Doc/library/codecs.rst (right): http://bugs.python.org/review/17827/diff/8606/Doc/library/codecs.rst#newcod… Doc/library/codecs.rst:27: Encodes obj using the codec registered for encoding. Errors may be given *encoding* http://bugs.python.org/review/17827/diff/8606/Doc/library/codecs.rst#newcod… Doc/library/codecs.rst:28: to set a different error handling scheme. Default is ``strict`` meaning that ``'strict'`` http://bugs.python.org/review/17827/diff/8606/Doc/library/codecs.rst#newcod… Doc/library/codecs.rst:30: ``replace`` and ``xmlcharrefreplace`` as well as any other name registered with These lines are too long. http://bugs.python.org/review/17827/diff/8606/Doc/library/codecs.rst#newcod… Doc/library/codecs.rst:31: ``codecs.register_error`` that can handle :exc:`ValueError`. I think there's already a list of valid error handlers somewhere, so you could just link to that instead of repeating them here. http://bugs.python.org/review/17827/

1 0

[issue18663] In unittest.TestCase.assertAlmostEqual doc specify the delta description
by py.user Aug. 11, 2013

Aug. 11, 2013

New submission from py.user: http://docs.python.org/3/library/unittest.html#unittest.TestCase.assertAlmo… "If delta is supplied instead of places then the difference between first and second must be less (or more) than delta." ---------- assignee: docs@python components: Documentation files: issue.diff keywords: patch messages: 194498 nosy: docs@python, py.user priority: normal severity: normal status: open title: In unittest.TestCase.assertAlmostEqual doc specify the delta description type: enhancement versions: Python 3.4 Added file: http://bugs.python.org/file31167/issue.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18663> _______________________________________

3 2

[issue18445] Tools/Script/Readme is outdated
by Seydou Dia Aug. 11, 2013

Aug. 11, 2013

Seydou Dia added the comment: >>- README says all python scripts are executables, but some need chmod +x >I can help here. Sorry I meant : "I can't help here". :) ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18445> _______________________________________

1 0

[issue18445] Tools/Script/Readme is outdated
by Seydou Dia Aug. 11, 2013

Aug. 11, 2013

Seydou Dia added the comment: >Several issues : >- abitype.py, analyze_dxp.py, get-remote-certificate.py, import_diagnostics.py, parse_html5_entities.py are not documented. Except analyze_dxp.py, all those files have been docummented in README. analyze_dxp.py was already documented so I don't understand what action is needed. Note that I have also documented find-uname.py. >- README mentions redemo.py which was moved to Tools/Demo. Done. >- README says all python scripts are executables, but some need chmod +x I can help here. > - The script list in readme would benefit from being sorted in alphabetical order Done. ---------- keywords: +patch Added file: http://bugs.python.org/file31229/issue-18445.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18445> _______________________________________

1 0

[issue18445] Tools/Script/Readme is outdated
by sdia Aug. 11, 2013

Aug. 11, 2013

sdia added the comment: Hello, I will try to submit a patch for this issue. ---------- nosy: +seydou _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18445> _______________________________________

1 0

[issue18676] Queue: document that zero is accepted as timeout value
by Terry J. Reedy Aug. 10, 2013

Aug. 10, 2013

Terry J. Reedy added the comment: Zhongyue, we merge 3.x patches forward (currently 3.3 to 3.4) so only one patch is usually needed unless the differences are non-trivial. It is easier if different version patches are tagged with the version in the filename.('-27', for instance. If you think you will ever contribute another patch, especially one less trivial than this one, please go to http://www.python.org/psf/contrib/ and http://www.python.org/psf/contrib/contrib-form/ Note that the agreement can now be submitted electronically. ---------- resolution: -> fixed stage: commit review -> committed/rejected status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18676> _______________________________________

1 0

[issue18676] Queue: document that zero is accepted as timeout value
by Roundup Robot Aug. 10, 2013

Aug. 10, 2013

Roundup Robot added the comment: New changeset 737b53ec5d1a by Terry Jan Reedy in branch '2.7': Issue #18676: Change 'positive' to 'non-negative' in queue.py put and get http://hg.python.org/cpython/rev/737b53ec5d1a New changeset 2122d56d6bc5 by Terry Jan Reedy in branch '3.3': Issue #18676: Change 'positive' to 'non-negative' in queue.py put and get http://hg.python.org/cpython/rev/2122d56d6bc5 New changeset d9a9fe5e700d by Terry Jan Reedy in branch 'default': Issue #18676: Merge from 3.3 http://hg.python.org/cpython/rev/d9a9fe5e700d ---------- nosy: +python-dev _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18676> _______________________________________

1 0