Mailman 3 July 2016 - docs

[issue23943] Misspellings in a few files
by Piotr Kasprzyk July 27, 2016

July 27, 2016

New submission from Piotr Kasprzyk: Correct misspellings in various files. ---------- assignee: docs@python components: Documentation files: misspellings.patch keywords: patch messages: 240825 nosy: docs@python, kwadrat priority: normal severity: normal status: open title: Misspellings in a few files type: enhancement versions: Python 3.5 Added file: http://bugs.python.org/file38977/misspellings.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23943> _______________________________________

3 4

[issue27633] Doc: Add missing version info to email.parser
by Berker Peksag July 27, 2016

July 27, 2016

Berker Peksag added the comment: Good catch, thanks! ---------- nosy: +berker.peksag resolution: -> fixed stage: commit review -> resolved status: open -> closed type: enhancement -> behavior versions: -Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27633> _______________________________________

1 0

[issue27633] Doc: Add missing version info to email.parser
by Roundup Robot July 27, 2016

July 27, 2016

Roundup Robot added the comment: New changeset 3f2e37e705d3 by Berker Peksag in branch '3.5': Issue #27633: Fix usage of versionchanged directive in email.parser.rst https://hg.python.org/cpython/rev/3f2e37e705d3 New changeset 8224ad99842e by Berker Peksag in branch 'default': Issue #27633: Merge from 3.5 https://hg.python.org/cpython/rev/8224ad99842e ---------- nosy: +python-dev _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27633> _______________________________________

1 0

[issue27633] Doc: Add missing version info to email.parser
by SilentGhost July 27, 2016

July 27, 2016

SilentGhost added the comment: LGTM ---------- assignee: -> docs@python components: +Documentation nosy: +SilentGhost, docs@python stage: -> commit review _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27633> _______________________________________

1 0

[issue27622] int.to_bytes(): docstring is not precise
by Марк Коренберг July 26, 2016

July 26, 2016

New submission from Марк Коренберг: Docstring says: The signed keyword-only argument determines whether two's complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised. But actually, (130).to_bytes(1, 'big', signed=True) will also trigger OverflowError ---------- assignee: docs@python components: Documentation, Library (Lib) messages: 271327 nosy: docs@python, mmarkk priority: normal severity: normal status: open title: int.to_bytes(): docstring is not precise type: enhancement versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27622> _______________________________________

4 12

[issue27626] Spelling fixes
by SilentGhost July 26, 2016

July 26, 2016

Changes by SilentGhost <ghost.adh(a)runbox.com>: ---------- assignee: -> docs@python components: +Documentation nosy: +SilentGhost, docs@python stage: -> patch review type: enhancement -> behavior versions: +Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27626> _______________________________________

1 0

Re: [docs] Patch to enhance literal block language declaration (issue 26462)
by python＠mandark.fr July 26, 2016

July 26, 2016

Thanks for all that feedback I should clearly have reviewed my patch deeper, not prod of me... I'm submitting "issue26462.v5.diff", I'm trying to generate a diff format that rietveld will understand but I'm not sure to one-shot it, I'm using: git diff --staged | sed 's/^$@@ .* @@$.*$/\1/g' | grep -v '^index' > issue26462.v5.diff (I may also learn to use mercurial, but as it look you're migrating to git, I'm not sure it's worth the effort. But if it's the only way to generate rietveld-compatible patches and it saves you time (by not having to regenerate each of my patches), tell me and I'll do. If my sed is enough, cool). https://bugs.python.org/review/26462/diff/17976/Doc/extending/newtypes.rst File Doc/extending/newtypes.rst (right): https://bugs.python.org/review/26462/diff/17976/Doc/extending/newtypes.rst#… Doc/extending/newtypes.rst:212: in a file called :file:`setup.py`; then typing: On 2016/07/26 08:32:56, vadmium wrote: > Not a big deal, but I don’t think this colon is needed Done. https://bugs.python.org/review/26462/diff/17976/Doc/library/2to3.rst File Doc/library/2to3.rst (right): https://bugs.python.org/review/26462/diff/17976/Doc/library/2to3.rst#newcod… Doc/library/2to3.rst:63: can be given with :option:`-f`. Likewise the :option:`-x` explicitly disables a On 2016/07/26 08:32:56, vadmium wrote: > I presume this line was changed accidentally. The :option:`-x` link is wrong; > see <https://bugs.python.org/issue26638> where I made this change. Done. https://bugs.python.org/review/26462/diff/17976/Doc/library/decimal.rst File Doc/library/decimal.rst (right): https://bugs.python.org/review/26462/diff/17976/Doc/library/decimal.rst#new… Doc/library/decimal.rst:168: .. doctest:: On 2016/07/26 08:32:56, vadmium wrote: > $ make -C Doc/ doctest > . . . > WARNING: no code/output in doctest block at > /media/disk/home/proj/python/cpython/Doc/library/decimal.rst:168 > > Also, with or without this change, I get no highlighting. Perhaps there should > be a blank line inbetween? Done, it was the wrong Traceback indentation. https://bugs.python.org/review/26462/diff/17976/Doc/library/decimal.rst#new… Doc/library/decimal.rst:173: File "<stdin>", line 1, in <module> On 2016/07/26 08:32:56, vadmium wrote: > Or perhaps because of missing indentation here? Done, it was exactly this. https://bugs.python.org/review/26462/diff/17976/Doc/library/decimal.rst#new… Doc/library/decimal.rst:247: .. doctest:: On 2016/07/26 08:32:56, vadmium wrote: > WARNING: no code/output in doctest block at > /media/disk/home/proj/python/cpython/Doc/library/decimal.rst:247 Done. Missing newline after `.. doctest::` https://bugs.python.org/review/26462/diff/17976/Doc/library/logging.config.… File Doc/library/logging.config.rst (right): https://bugs.python.org/review/26462/diff/17976/Doc/library/logging.config.… Doc/library/logging.config.rst:635: Examples of these sections in the file are given below. : On 2016/07/26 08:32:56, vadmium wrote: > This produces a floating colon (:) at the end of the line. Perhaps remove it > completely? (same problem below) Done. https://bugs.python.org/review/26462/diff/17976/Doc/library/pyexpat.rst File Doc/library/pyexpat.rst (right): https://bugs.python.org/review/26462/diff/17976/Doc/library/pyexpat.rst#new… Doc/library/pyexpat.rst:874: not. See http://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl On 2016/07/26 08:32:56, vadmium wrote: > This is reverting an unrelated change (Issue 26736). I suggest not to mess with > newlines in files you edit without a good reason. Done, as my patch was a few month old it not merged properly, I should have reviewed it myself in depth... sry for that. https://bugs.python.org/review/26462/diff/17976/Doc/library/subprocess.rst File Doc/library/subprocess.rst (left): https://bugs.python.org/review/26462/diff/17976/Doc/library/subprocess.rst#… Doc/library/subprocess.rst:960: # becomes On 2016/07/26 08:32:56, vadmium wrote: > These are all hybrid python3 and Unix shell code. I guess “python” means Python > 2, where `...` means repr(...). > > I guess we could split here into two blocks (Unix shell and python3) Done (splitted). https://bugs.python.org/review/26462/diff/17976/Doc/whatsnew/3.3.rst File Doc/whatsnew/3.3.rst (left): https://bugs.python.org/review/26462/diff/17976/Doc/whatsnew/3.3.rst#oldcod… Doc/whatsnew/3.3.rst:1002: $ ./python -q On 2016/07/26 08:32:56, vadmium wrote: > I think you can just drop the python -q line instead Done (removed the line). https://bugs.python.org/review/26462/diff/17976/Doc/whatsnew/3.5.rst File Doc/whatsnew/3.5.rst (right): https://bugs.python.org/review/26462/diff/17976/Doc/whatsnew/3.5.rst#newcod… Doc/whatsnew/3.5.rst:294: .. code-block:: pycon On 2016/07/26 08:32:56, vadmium wrote: > $ make -C Doc/ suspicious PYTHON=python3 > . . . > WARNING: [whatsnew/3.5:294] "::" found in ".. code-block:: pycon" > > Maybe the double colon (::) needs adjusting? > > In fact, why is this change needed at all? Maybe it is just that my Sphinx or > whatever needs updating to understand the new operator. Without my buggy `::` I'm getting "Could not parse literal_block as "pycon"", clearly our parsers are not up-to-date and should be fixed. I'll see what I can do about it, but it's another unrelated patch so I just drop this `.. code-block:: pycon` and keep the warning to explicitly tell there's a problem here. https://bugs.python.org/review/26462/

1 0

Re: [docs] Patch to enhance literal block language declaration (issue 26462)
by vadmium+py＠gmail.com July 26, 2016

July 26, 2016

https://bugs.python.org/review/26462/diff/16666/Doc/whatsnew/3.2.rst File Doc/whatsnew/3.2.rst (right): https://bugs.python.org/review/26462/diff/16666/Doc/whatsnew/3.2.rst#newcod… Doc/whatsnew/3.2.rst:2048: .. code-block:: none On 2016/07/26 09:45:45, sizeof wrote: > On 2016/07/25 07:10:49, vadmium wrote: > > Pygments lexer name 'doscon' is not known > > doscon looks known to some pygments version, at least mine did not give the > warning about unknown lexer: > > http://pygments.org/docs/lexers/#pygments.lexers.shell.MSDOSSessionLexer Yeah I think it is safe to ignore this. After I posted that I discovered that you need Pygments 2.1 and I only have 2.0. https://bugs.python.org/review/26462/

1 0

Re: [docs] Patch to enhance literal block language declaration (issue 26462)
by python＠mandark.fr July 26, 2016

July 26, 2016

Reviewers: Zach Ware, Georg, vadmium, https://bugs.python.org/review/26462/diff/16666/Doc/whatsnew/3.2.rst File Doc/whatsnew/3.2.rst (right): https://bugs.python.org/review/26462/diff/16666/Doc/whatsnew/3.2.rst#newcod… Doc/whatsnew/3.2.rst:2048: .. code-block:: none On 2016/07/25 07:10:49, vadmium wrote: > Pygments lexer name 'doscon' is not known doscon looks known to some pygments version, at least mine did not give the warning about unknown lexer: http://pygments.org/docs/lexers/#pygments.lexers.shell.MSDOSSessionLexer Please review this at https://bugs.python.org/review/26462/ Affected files: Doc/distutils/examples.rst Doc/distutils/packageindex.rst Doc/distutils/sourcedist.rst Doc/extending/building.rst Doc/extending/embedding.rst Doc/extending/extending.rst Doc/extending/newtypes.rst Doc/faq/extending.rst Doc/howto/clinic.rst Doc/howto/logging-cookbook.rst Doc/howto/logging.rst Doc/howto/regex.rst Doc/howto/unicode.rst Doc/library/2to3.rst Doc/library/argparse.rst Doc/library/ast.rst Doc/library/asyncio-dev.rst Doc/library/cgi.rst Doc/library/cmd.rst Doc/library/decimal.rst Doc/library/doctest.rst Doc/library/email-examples.rst Doc/library/html.parser.rst Doc/library/idle.rst Doc/library/logging.config.rst Doc/library/optparse.rst Doc/library/pickletools.rst Doc/library/pyexpat.rst Doc/library/shutil.rst Doc/library/socketserver.rst Doc/library/subprocess.rst Doc/library/sys.rst Doc/library/sysconfig.rst Doc/library/tarfile.rst Doc/library/zipimport.rst Doc/reference/expressions.rst Doc/reference/lexical_analysis.rst Doc/tutorial/controlflow.rst Doc/tutorial/interpreter.rst Doc/tutorial/modules.rst Doc/whatsnew/2.3.rst Doc/whatsnew/2.4.rst Doc/whatsnew/2.7.rst Doc/whatsnew/3.0.rst Doc/whatsnew/3.2.rst Doc/whatsnew/3.3.rst Doc/whatsnew/3.5.rst

1 0

Re: [docs] Patch to enhance literal block language declaration (issue 26462)
by vadmium+py＠gmail.com July 25, 2016

July 25, 2016

https://bugs.python.org/review/26462/diff/17976/Doc/extending/newtypes.rst File Doc/extending/newtypes.rst (right): https://bugs.python.org/review/26462/diff/17976/Doc/extending/newtypes.rst#… Doc/extending/newtypes.rst:212: in a file called :file:`setup.py`; then typing: Not a big deal, but I don’t think this colon is needed https://bugs.python.org/review/26462/diff/17976/Doc/library/2to3.rst File Doc/library/2to3.rst (right): https://bugs.python.org/review/26462/diff/17976/Doc/library/2to3.rst#newcod… Doc/library/2to3.rst:63: can be given with :option:`-f`. Likewise the :option:`-x` explicitly disables a I presume this line was changed accidentally. The :option:`-x` link is wrong; see <https://bugs.python.org/issue26638> where I made this change. https://bugs.python.org/review/26462/diff/17976/Doc/library/decimal.rst File Doc/library/decimal.rst (right): https://bugs.python.org/review/26462/diff/17976/Doc/library/decimal.rst#new… Doc/library/decimal.rst:168: .. doctest:: $ make -C Doc/ doctest . . . WARNING: no code/output in doctest block at /media/disk/home/proj/python/cpython/Doc/library/decimal.rst:168 Also, with or without this change, I get no highlighting. Perhaps there should be a blank line inbetween? https://bugs.python.org/review/26462/diff/17976/Doc/library/decimal.rst#new… Doc/library/decimal.rst:173: File "<stdin>", line 1, in <module> Or perhaps because of missing indentation here? https://bugs.python.org/review/26462/diff/17976/Doc/library/decimal.rst#new… Doc/library/decimal.rst:247: .. doctest:: WARNING: no code/output in doctest block at /media/disk/home/proj/python/cpython/Doc/library/decimal.rst:247 https://bugs.python.org/review/26462/diff/17976/Doc/library/logging.config.… File Doc/library/logging.config.rst (right): https://bugs.python.org/review/26462/diff/17976/Doc/library/logging.config.… Doc/library/logging.config.rst:635: Examples of these sections in the file are given below. : This produces a floating colon (:) at the end of the line. Perhaps remove it completely? (same problem below) https://bugs.python.org/review/26462/diff/17976/Doc/library/pyexpat.rst File Doc/library/pyexpat.rst (right): https://bugs.python.org/review/26462/diff/17976/Doc/library/pyexpat.rst#new… Doc/library/pyexpat.rst:874: not. See http://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl This is reverting an unrelated change (Issue 26736). I suggest not to mess with newlines in files you edit without a good reason. https://bugs.python.org/review/26462/diff/17976/Doc/library/subprocess.rst File Doc/library/subprocess.rst (left): https://bugs.python.org/review/26462/diff/17976/Doc/library/subprocess.rst#… Doc/library/subprocess.rst:960: # becomes These are all hybrid python3 and Unix shell code. I guess “python” means Python 2, where `...` means repr(...). I guess we could split here into two blocks (Unix shell and python3) https://bugs.python.org/review/26462/diff/17976/Doc/whatsnew/3.3.rst File Doc/whatsnew/3.3.rst (left): https://bugs.python.org/review/26462/diff/17976/Doc/whatsnew/3.3.rst#oldcod… Doc/whatsnew/3.3.rst:1002: $ ./python -q I think you can just drop the python -q line instead https://bugs.python.org/review/26462/diff/17976/Doc/whatsnew/3.5.rst File Doc/whatsnew/3.5.rst (right): https://bugs.python.org/review/26462/diff/17976/Doc/whatsnew/3.5.rst#newcod… Doc/whatsnew/3.5.rst:294: .. code-block:: pycon $ make -C Doc/ suspicious PYTHON=python3 . . . WARNING: [whatsnew/3.5:294] "::" found in ".. code-block:: pycon" Maybe the double colon (::) needs adjusting? In fact, why is this change needed at all? Maybe it is just that my Sphinx or whatever needs updating to understand the new operator. https://bugs.python.org/review/26462/

1 0