Mailman 3 February 2017 - docs

Tiny typos in https://docs.python.org/3/library/weakref.html#weakref.WeakValueDictionary
by Arthur Goldberg 07 Feb '17

07 Feb '17

s/have the following additional methods. These method have/have the following additional method. This method has/ s/ issues as the and|keyrefs()|/ issues as the|keyrefs()|/ HTH A -- Arthur Goldberg https://www.linkedin.com/in/arthurgoldberg artgoldberg(a)gmail.com

2 1

[issue26355] Emit major version based canonical URLs for docs
by Nick Coghlan 07 Feb '17

07 Feb '17

Nick Coghlan added the comment: OK, I've marked 2.7 and 3.5+ as the minimal set of versions to get the change via the CPython source repo. However, looking at the results of https://www.google.com/search?q=python+httplib and https://www.google.com/search?q=python+http+client I think it's going to be worth backfilling the old branches as well - having multiple different versions of the 3.x documentation showing up in search results isn't helpful to anyone. ---------- versions: +Python 2.7, Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26355> _______________________________________

1 0

[issue29441] Update examples to use async and await keywords in asyncio-task.rst
by Berker Peksag 07 Feb '17

07 Feb '17

New submission from Berker Peksag: Attached patch converts all examples that use @coroutine decorator in Doc/library/asyncio-task.rst. I also removed the generator example at https://docs.python.org/3/library/asyncio-task.html#example-coroutine-displ… See issue 29407 for context. ---------- assignee: docs@python components: Documentation, asyncio files: update-examples-task.diff keywords: patch messages: 286911 nosy: berker.peksag, docs@python, gvanrossum, yselivanov priority: normal severity: normal stage: patch review status: open title: Update examples to use async and await keywords in asyncio-task.rst type: enhancement versions: Python 3.5, Python 3.6, Python 3.7 Added file: http://bugs.python.org/file46508/update-examples-task.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29441> _______________________________________

4 7

[issue26355] Emit major version based canonical URLs for docs
by Berker Peksag 07 Feb '17

07 Feb '17

Berker Peksag added the comment: Patch looks good to me too, thanks! Just left a super minor comment on Rietveld. You might want to commit this to 3.5+ because we don't daily build 3.4 docs anymore: https://github.com/python/docsbuild-scripts/blob/master/build_docs.py#L30 I didn't see any links from 2.6 or older Python 2 versions in search results before so I don't have a strong opinion on backporting the patch to 2.7 (I probably wouldn't bother with Python 2 docs anymore :)) ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26355> _______________________________________

1 0

Emit major version based canonical URLs for docs (issue 26355)
by berker.peksag＠gmail.com 07 Feb '17

07 Feb '17

http://bugs.python.org/review/26355/diff/19842/Doc/tools/templates/layout.h… File Doc/tools/templates/layout.html (right): http://bugs.python.org/review/26355/diff/19842/Doc/tools/templates/layout.h… Doc/tools/templates/layout.html:41: <link rel="canonical" href="https://docs.python.org/3/{{pagename}}.html"/> Can we add a space before '/>' to be consistent with the rest of file? http://bugs.python.org/review/26355/

1 0

[issue29371] Typo in doctest documentation
by Marco Buttu 07 Feb '17

07 Feb '17

New submission from Marco Buttu: >From the doctest documentation [1]: "Symbolic names for the flags are supplied as module constants, which can be or'ed together and passed to various functions." Is there a typo in "...which can be or'ed together..."? Maybe "collected together"? [1] https://docs.python.org/3/library/doctest.html#option-flags ---------- assignee: docs@python components: Documentation messages: 286254 nosy: docs@python, marco.buttu priority: normal severity: normal status: open title: Typo in doctest documentation versions: Python 2.7, Python 3.3, Python 3.4, Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29371> _______________________________________

5 17

[issue26355] Emit major version based canonical URLs for docs
by Matthias Bussonnier 07 Feb '17

07 Feb '17

Matthias Bussonnier added the comment: Thanks Nick, I can work on the similar patch for Python 2.7. I'll wait for the migration to GitHub which IIRC should be soon. Side question, is there some metrics (like google analytics) to know how much traffic there is on older Python docs and if it's worth patching ? ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26355> _______________________________________

1 0

[issue26355] Emit major version based canonical URLs for docs
by Nick Coghlan 06 Feb '17

06 Feb '17

Nick Coghlan added the comment: Thanks Matthias! Regarding 2v3, the layout differences aren't a problem, since the canonical URLs are separate (/2/* vs /3/*). That's one of the benefits I actually hope for with this change - due to PEP 430, deep links still go to the Python 2 documentation by default, and once this change is made in the Python 2.7 branch it should teach search engines that those should start being presented in results as "/2/*" qualified links. We also don't tend to make wholesale changes to the URL layouts in the docs in X.Y releases, so I think the assumption of "the relative path of this page won't change" is fine. Georg, Berker - any further thoughts before we make this change to 3.4+ and the 2.7 docs? ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26355> _______________________________________

1 0

[issue26355] Emit major version based canonical URLs for docs
by Berker Peksag 06 Feb '17

06 Feb '17

Changes by Berker Peksag <berker.peksag(a)gmail.com>: ---------- nosy: +berker.peksag stage: needs patch -> patch review _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26355> _______________________________________

1 0

[issue28489] Fix comment in tokenizer.c
by Ryan Gonzalez 05 Feb '17

05 Feb '17

New submission from Ryan Gonzalez: Attached is a little fix for a comment in tokenizer.c. I noticed that it was never updated for the inclusion of f-strings. ---------- assignee: docs@python components: Documentation files: 0001-Fix-comment-in-tokenizer.c.patch keywords: patch messages: 279056 nosy: Ryan.Gonzalez, docs@python priority: normal severity: normal status: open title: Fix comment in tokenizer.c versions: Python 3.6 Added file: http://bugs.python.org/file45156/0001-Fix-comment-in-tokenizer.c.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue28489> _______________________________________

6 14