Mailman 3 November 2013 - docs

[issue19836] selectors: improve examples section
by Charles-François Natali 29 Nov '13

29 Nov '13

New submission from Charles-François Natali: Here's a patch improving the "examples" section for the selectors module. ---------- assignee: docs@python components: Documentation files: selectors_examples.diff keywords: needs review, patch messages: 204750 nosy: docs@python, neologix priority: normal severity: normal stage: patch review status: open title: selectors: improve examples section type: enhancement versions: Python 3.4 Added file: http://bugs.python.org/file32894/selectors_examples.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue19836> _______________________________________

3 9

[issue19454] devguide: Document what a "platform support" is
by anatoly techtonik 29 Nov '13

29 Nov '13

New submission from anatoly techtonik: As a followup to issue19377 it would be nice if devguide contained a paragraph to resolve the conflicting point provided by http://bugs.python.org/msg187373 and http://bugs.python.org/msg201141 arguments. ---------- assignee: docs@python components: Devguide, Documentation messages: 201762 nosy: docs@python, ezio.melotti, techtonik priority: normal severity: normal status: open title: devguide: Document what a "platform support" is _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue19454> _______________________________________

4 3

[issue19809] Doc: subprocess should warn uses on race conditions when multiple threads spawn child processes
by STINNER Victor 27 Nov '13

27 Nov '13

Changes by STINNER Victor <victor.stinner(a)gmail.com>: ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python title: Python get stuck in second Popen call -> Doc: subprocess should warn uses on race conditions when multiple threads spawn child processes _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue19809> _______________________________________

1 0

[issue19805] Revise FAQ Dictionary: consistent key order item
by Graham Wideman 27 Nov '13

27 Nov '13

New submission from Graham Wideman: FAQ entry: http://docs.python.org/3/faq/programming.html#how-can-i-get-a-dictionary-to… claims that there's no way for a dictionary to return keys in a consistent order. However, there's OrderedDict which should probably be mentioned here. ---------- assignee: docs@python components: Documentation messages: 204550 nosy: docs@python, gwideman priority: normal severity: normal status: open title: Revise FAQ Dictionary: consistent key order item type: enhancement versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue19805> _______________________________________

2 1

Re: [docs] Formatting of True/False in docs (issue 19795)
by georg＠python.org 26 Nov '13

26 Nov '13

http://bugs.python.org/review/19795/diff/10113/Doc/library/logging.rst File Doc/library/logging.rst (right): http://bugs.python.org/review/19795/diff/10113/Doc/library/logging.rst#newc… Doc/library/logging.rst:163: ``False``. If specified as True, stack information is added to the logging On 2013/11/26 20:56:30, storchaka wrote: > On 2013/11/26 18:37:58, Georg wrote: > > you missed a True here > > I doubt about wording. Any true value means same as ``True`` in boolean context. > But "as true" perhaps doesn't sound right. Could you please propose right > wording? Just "If true" should be good. http://bugs.python.org/review/19795/diff/10113/Doc/library/sqlite3.rst File Doc/library/sqlite3.rst (right): http://bugs.python.org/review/19795/diff/10113/Doc/library/sqlite3.rst#newc… Doc/library/sqlite3.rst:245: can call this function with *flag* as true. Afterwards, you will get tracebacks On 2013/11/26 20:56:30, storchaka wrote: > On 2013/11/26 18:37:58, Georg wrote: > > "with flag as true" doesn't sound right -- this could be formulated > differently > > while you're at it > > I can't do this. Could you please propose better wording? Hmm, what about "you can call this function with *flag* set to ``True``" http://bugs.python.org/review/19795/

1 0

Re: [docs] Formatting of True/False in docs (issue 19795)
by storchaka＠gmail.com 26 Nov '13

26 Nov '13

Reviewers: Georg, Message: Thank you Georg. Could you please help me with wording in doubtful places? http://bugs.python.org/review/19795/diff/10113/Doc/library/dis.rst File Doc/library/dis.rst (right): http://bugs.python.org/review/19795/diff/10113/Doc/library/dis.rst#newcode2… Doc/library/dis.rst:272: line started by this opcode (if any), otherwise None On 2013/11/26 18:37:58, Georg wrote: > None should also be ``-ified :) another patch forthcoming? Good idea. I'll submit new patch later. http://bugs.python.org/review/19795/diff/10113/Doc/library/logging.rst File Doc/library/logging.rst (right): http://bugs.python.org/review/19795/diff/10113/Doc/library/logging.rst#newc… Doc/library/logging.rst:163: ``False``. If specified as True, stack information is added to the logging On 2013/11/26 18:37:58, Georg wrote: > you missed a True here I doubt about wording. Any true value means same as ``True`` in boolean context. But "as true" perhaps doesn't sound right. Could you please propose right wording? There are other places which I have not changed for the same reason. http://bugs.python.org/review/19795/diff/10113/Doc/library/sqlite3.rst File Doc/library/sqlite3.rst (right): http://bugs.python.org/review/19795/diff/10113/Doc/library/sqlite3.rst#newc… Doc/library/sqlite3.rst:245: can call this function with *flag* as true. Afterwards, you will get tracebacks On 2013/11/26 18:37:58, Georg wrote: > "with flag as true" doesn't sound right -- this could be formulated differently > while you're at it I can't do this. Could you please propose better wording? http://bugs.python.org/review/19795/diff/10113/Doc/reference/datamodel.rst File Doc/reference/datamodel.rst (right): http://bugs.python.org/review/19795/diff/10113/Doc/reference/datamodel.rst#… Doc/reference/datamodel.rst:203: These represent the truth values ``False`` and ``True``. The two objects representing On 2013/11/26 18:37:58, Georg wrote: > this should not be code since it's not talking about the objects, but the > (Platonic ideal) values. Done. Please review this at http://bugs.python.org/review/19795/ Affected files: Doc/howto/curses.rst Doc/howto/functional.rst Doc/library/ast.rst Doc/library/bdb.rst Doc/library/bz2.rst Doc/library/ctypes.rst Doc/library/difflib.rst Doc/library/dis.rst Doc/library/email.message.rst Doc/library/functions.rst Doc/library/gc.rst Doc/library/http.client.rst Doc/library/http.cookiejar.rst Doc/library/imp.rst Doc/library/importlib.rst Doc/library/io.rst Doc/library/itertools.rst Doc/library/logging.handlers.rst Doc/library/logging.rst Doc/library/lzma.rst Doc/library/mmap.rst Doc/library/nntplib.rst Doc/library/os.path.rst Doc/library/os.rst Doc/library/pickle.rst Doc/library/plistlib.rst Doc/library/sched.rst Doc/library/sqlite3.rst Doc/library/ssl.rst Doc/library/stdtypes.rst Doc/library/struct.rst Doc/library/subprocess.rst Doc/library/sys.rst Doc/library/tarfile.rst Doc/library/tkinter.ttk.rst Doc/library/turtle.rst Doc/library/unittest.mock.rst Doc/library/urllib.request.rst Doc/library/venv.rst Doc/library/zipfile.rst Doc/library/zipimport.rst Doc/reference/datamodel.rst Doc/whatsnew/3.3.rst

1 0

[issue19793] Formatting of True/Falsein in pathlib docs
by Serhiy Storchaka 26 Nov '13

26 Nov '13

New submission from Serhiy Storchaka: The proposed patch improves formatting of True/False in pathlib documentation. "True" becomes "``True``" if it means True constant and "true" if it means true value. ---------- assignee: docs@python components: Documentation messages: 204461 nosy: chris.jerdonek, docs@python, pitrou, serhiy.storchaka priority: normal severity: normal stage: patch review status: open title: Formatting of True/Falsein in pathlib docs type: enhancement versions: Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue19793> _______________________________________

4 6

Formatting of True/False in pathlib docs (issue 19793)
by georg＠python.org 26 Nov '13

26 Nov '13

LGTM. http://bugs.python.org/review/19793/

1 0

Formatting of True/False in docs (issue 19795)
by georg＠python.org 26 Nov '13

26 Nov '13

Looks good overall, see a few comments. http://bugs.python.org/review/19795/diff/10113/Doc/library/dis.rst File Doc/library/dis.rst (right): http://bugs.python.org/review/19795/diff/10113/Doc/library/dis.rst#newcode2… Doc/library/dis.rst:272: line started by this opcode (if any), otherwise None None should also be ``-ified :) another patch forthcoming? http://bugs.python.org/review/19795/diff/10113/Doc/library/logging.rst File Doc/library/logging.rst (right): http://bugs.python.org/review/19795/diff/10113/Doc/library/logging.rst#newc… Doc/library/logging.rst:163: ``False``. If specified as True, stack information is added to the logging you missed a True here http://bugs.python.org/review/19795/diff/10113/Doc/library/logging.rst#newc… Doc/library/logging.rst:881: ``False``. If specified as True, stack information is added to the logging another True missed http://bugs.python.org/review/19795/diff/10113/Doc/library/sqlite3.rst File Doc/library/sqlite3.rst (right): http://bugs.python.org/review/19795/diff/10113/Doc/library/sqlite3.rst#newc… Doc/library/sqlite3.rst:245: can call this function with *flag* as true. Afterwards, you will get tracebacks "with flag as true" doesn't sound right -- this could be formulated differently while you're at it http://bugs.python.org/review/19795/diff/10113/Doc/reference/datamodel.rst File Doc/reference/datamodel.rst (right): http://bugs.python.org/review/19795/diff/10113/Doc/reference/datamodel.rst#… Doc/reference/datamodel.rst:203: These represent the truth values ``False`` and ``True``. The two objects representing this should not be code since it's not talking about the objects, but the (Platonic ideal) values. http://bugs.python.org/review/19795/

1 0

[issue19794] Formatting of True/False in decimal docs
by Serhiy Storchaka 26 Nov '13

26 Nov '13

New submission from Serhiy Storchaka: The proposed patch improves formatting of True/False in decimal documentation. "True/False" constants become "``True``/``False``". ---------- assignee: docs@python components: Documentation files: doc_decimal_truefalse.patch keywords: patch messages: 204462 nosy: docs@python, facundobatista, mark.dickinson, rhettinger, serhiy.storchaka, skrah priority: normal severity: normal stage: patch review status: open title: Formatting of True/False in decimal docs type: enhancement versions: Python 3.3, Python 3.4 Added file: http://bugs.python.org/file32853/doc_decimal_truefalse.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue19794> _______________________________________

3 3