Mailman 3 February 2017 - docs

[issue28941] Update the link to Source Code in Python Docs from hg to github
by Mariatta Wijaya 13 Feb '17

13 Feb '17

New submission from Mariatta Wijaya: Some Python docs include a link to the Source Code, for example: https://docs.python.org/3.6/library/abc.html Once the repo is moved to github, the link should probably be updated to point to github: https://github.com/python/cpython/blob/master/Lib/abc.py ---------- assignee: docs@python components: Documentation messages: 282960 nosy: Mariatta, docs@python priority: normal severity: normal status: open title: Update the link to Source Code in Python Docs from hg to github versions: Python 2.7, Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue28941> _______________________________________

2 10

os.ftruncate documentation error
by Richard Ipsum 12 Feb '17

12 Feb '17

Hi folks, The documentation for os.ftruncate seems a little misleading, for both 2.7[1] and 3.6[2] the docs for os.ftruncate say, "Truncate the file corresponding to file descriptor fd, so that it is at most length bytes in size." os.ftruncate is implemented on Unix as a call to ftruncate(2), the man page for which states: "The truncate() and ftruncate() functions cause the regular file named by path or referenced by fd to be truncated to a size of precisely length bytes." The distinction between 'at most' and 'precisely' is quite an important one, it's quite possible that there is some difference in behaviour on certain platforms, but if that is the case then I think the docs ought to make that clear. I'll be quite happy to submit a patch to make the docs clearer, if I can get a little direction on what sort of change would be best. Hope this helps, thanks, Richard Ipsum [1]: https://docs.python.org/2.7/library/os.html?highlight=os.ftruncate#os.ftrun… [2]: https://docs.python.org/3.6/library/os.html?highlight=os.ftruncate#os.ftrun…

1 1

[issue28739] PEP 498: docstrings as f-strings
by Joakim Soderlund 11 Feb '17

11 Feb '17

Joakim Soderlund added the comment: I got slightly confused here while playing around. Python 3.6.0 (default, Jan 31 2017, 11:39:39) [GCC 4.9.2] on linux Type "help", "copyright", "credits" or "license" for more information. >>> class Huacaya: ... f"""Huacaya!""" ... >>> class Suri: ... f"""{'Suri!'}""" ... >>> Huacaya.__doc__ is None False >>> Suri.__doc__ is None True At first I thought f-strings *did* work as docstrings since it worked just fine for the first class. But, the docstring suddenly vanished when putting an actual expression into it. ---------- nosy: +JockeTF _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue28739> _______________________________________

1 0

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

09 Feb '17

Matthias Bussonnier added the comment: > turn my "we should do this" idea into a change we've actually made :) Looking forward to being able to do this more on GitHub as I am more familiar with git. Good luck for the transition, I'm pretty sure there will be some hard time in the next few weeks. ---------- _______________________________________ 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 09 Feb '17

09 Feb '17

Nick Coghlan added the comment: Matthias - thanks for figuring out how to turn my "we should do this" idea into a change we've actually made :) ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26355> _______________________________________

1 0

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

09 Feb '17

Matthias Bussonnier added the comment: > OK, I'm marking this as closed, since it's as resolved as we can make it through a *CPython* change. Thanks you Nick, I appreciate the time you took to do that. ANd thank you Berker for the review. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26355> _______________________________________

1 0

[issue26355] Emit major version based canonical URLs for docs
by Roundup Robot 09 Feb '17

09 Feb '17

Roundup Robot added the comment: New changeset e8455e7137b9bd63d4c0183558161dba6ea00d32 by Nick Coghlan in branch '2.7': Issue #26355: Specify canonical URLs in docs pages https://github.com/python/cpython/commit/e8455e7137b9bd63d4c0183558161dba6e… ---------- _______________________________________ 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 09 Feb '17

09 Feb '17

Nick Coghlan added the comment: OK, I'm marking this as closed, since it's as resolved as we can make it through a *CPython* change. Since the old branches aren't autobuilt anymore, adding a canonical URL reference to them would presumably be a matter of running a script over the built docs. ---------- resolution: -> fixed stage: commit review -> resolved status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26355> _______________________________________

1 0

[issue26355] Emit major version based canonical URLs for docs
by Roundup Robot 09 Feb '17

09 Feb '17

Roundup Robot added the comment: New changeset b07d454e45a2 by Nick Coghlan in branch '2.7': Issue #26355: Specify canonical URLs in docs pages https://hg.python.org/cpython/rev/b07d454e45a2 ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26355> _______________________________________

1 0

[issue26355] Emit major version based canonical URLs for docs
by Roundup Robot 09 Feb '17

09 Feb '17

Roundup Robot added the comment: New changeset a47e20b636d2a5559e5831c6805df3cba1ddb2a1 by Nick Coghlan in branch '3.5': Issue #26355: Specify canonical URLs in docs pages https://github.com/python/cpython/commit/a47e20b636d2a5559e5831c6805df3cba1… ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26355> _______________________________________

1 0