Roundup Robot added the comment:
New changeset bd14c4e5ef00 by Berker Peksag in branch '3.4':
Issue #12602: Add missing cross-references to runpy and using/cmdline docs.
https://hg.python.org/cpython/rev/bd14c4e5ef00
New changeset 3a648b3d1694 by Berker Peksag in branch 'default':
Issue #12602:
Roundup Robot added the comment:
New changeset 078dbecf2e2c by Berker Peksag in branch '2.7':
Issue #12602: Add missing cross-references to runpy and using/cmdline docs.
https://hg.python.org/cpython/rev/078dbecf2e2c
--
___
Python tracker
Berker Peksag added the comment:
Thanks for the patch, Éric.
--
assignee: eric.araujo - berker.peksag
nosy: +berker.peksag
resolution: - fixed
stage: commit review - resolved
status: open - closed
type: behavior - enhancement
___
Python tracker
Ezio Melotti added the comment:
Patch LGTM.
--
stage: needs patch - commit review
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue12602
___
___
Changes by Mark Lawrence breamore...@yahoo.co.uk:
--
type: - behavior
versions: +Python 3.4, Python 3.5 -Python 3.2, Python 3.3
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue12602
___
Éric Araujo mer...@netwok.org added the comment:
Attached path adds these links:
Missing incoming:
- from Invoking the Interpreter in the tutorial
- direct link from runpy.run_module to -m switch
Missing outgoing:
- direct link from script to runpy.run_path
I couldn’t add this one:
-
Éric Araujo mer...@netwok.org added the comment:
[Terry]
It may suggest a meta-issue though - perhaps 'Documenting Python'
should grow a devguide-style description of the Docs layout in source
control
I would just describe the layout of the Doc subtree in the same devguide page.
Care to
Éric Araujo mer...@netwok.org added the comment:
BTW, I’ve done nothing about #1739468 because I don’t see why you wanted to add
a link.
--
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue12602
Éric Araujo mer...@netwok.org added the comment:
I suggest that it do so in this instance also, using *script* (in
bold-faced italic) as the entry title.
What do you think about :file:`{script}`? file+{} is what Sphinx uses for
filenames with replaceable parts, which map to the HTML var
Ezio Melotti ezio.melo...@gmail.com added the comment:
The italics parts are easier to recognize when they are within regular text
(e.g. :file:`path/with/python{XY}/file`). If the whole text is in italic
people might not notice the difference.
--
Terry J. Reedy tjre...@udel.edu added the comment:
Since *script* is a file -- that is all variable -- that seems appropriate.
Bold italic tends to be more notably different from bold italic than the normal
pair. In any case, italic is the doc standard for function parameter names. It
seems
Éric Araujo mer...@netwok.org added the comment:
For new doc editors, it would be nicer if the filename (directory name,
actually)
had been changed to 'py_setup' or even 'py_usage'.
py_setup would conflict with pysetup, the installer part of
distutils2/packaging. py_ seems redundant to me,
Terry J. Reedy tjre...@udel.edu added the comment:
I was not necessary suggesting that the filename actually be changed, just that
the mapping between docs and filenames is not always obvious. I will somedays
look at the dev docs doc page and see if I have any further suggestions to help.
Add
Nick Coghlan ncogh...@gmail.com added the comment:
Don't feel bad about not recognising the context - this stuff wasn't documented
at all for a long time, and it wasn't until Georg pointed me to the usage docs
that I realised adding it there would be the right place. I should have
remembered
Terry J. Reedy tjre...@udel.edu added the comment:
That was the page I said I would look at. My suggest is that one or more of the
directory entries could have either a bit more information about the directory
or a More info link to a separate page. As a remember, files for modules were
named
Changes by Mike Hoy mho...@gmail.com:
--
nosy: -mikehoy
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue12602
___
___
Python-bugs-list mailing list
Éric Araujo mer...@netwok.org added the comment:
Terry, might that other issue be #12298?
--
title: Missing using docs cross-references - Missing cross-references in
Doc/using
___
Python tracker rep...@bugs.python.org
Terry J. Reedy tjre...@udel.edu added the comment:
As of 2.7/3.2, the doc is named Python Setup and Usage at
http://docs.python.org/index.html
http://docs.python.org/using/cmdline.html (and other chapters)
and in the contents list of the Windows help version.
For new doc editors, it would be
18 matches
Mail list logo
