Bryce Verdier bryceverd...@gmail.com added the comment:
No worries, I totally understand. I was working on it a little bit at a time,
as life would allow. And being probably more thorough than I needed to be. Here
is the patch of everything that I've accomplished. Hope this helps.
--
Éric Araujo mer...@netwok.org added the comment:
After thinking about this, I think it may be easier for everyone if I just did
the change. It’s just a list of boring grep-sed combos to run, and it’s easier
if a core dev just does it instead of reviewing a long patch. Sorry if you
invested
Éric Araujo mer...@netwok.org added the comment:
I would like to help out with this, as there seems to be a lot of
work that needs to be done.
Thanks! In my initial report, I was talking only about module-level names that
are documented as code (``sys.path``) instead of module-level data
Éric Araujo mer...@netwok.org added the comment:
instead of*
An addition: in some cases, it may be on purpose that someone used ``somename``
instead of :func:`somename`, for example to avoid a ton of link in the doc of
the somename function. For the most part however, I believe it was just
Ezio Melotti ezio.melo...@gmail.com added the comment:
``...`` should also be used for common names like True, False, None (no one
needs links to their doc to see what they are), or, as Éric said, to avoid
creating links for each occurrence of a name (one such example is the name of a
module
Terry J. Reedy tjre...@udel.edu added the comment:
Changing ``x`` to :data:`x` adds 4 chars.
Changing ``x()`` to :func:`x` justs adds 2.
If I were to review, I would prefer that the additions not trigger cascading
line rewraps.
--
___
Python tracker
Bryce Verdier bryceverd...@gmail.com added the comment:
I would like to help out with this, as there seems to be a lot of work that
needs to be done.
I guess I'm a little unsure about what you mean by ``code`` instead of :data:.
Is ``code`` generic? Like in Doc/tutorials/classes.rst I see a
Ezio Melotti ezio.melo...@gmail.com added the comment:
Nope, ``...`` can be used for generic pieces of code, whereas e.g.
:data:`sys.stdout` indicates that stdout is a data attribute of the sys
module.
If you use :data:`...` and rebuild the doc (cd Doc/; make html), you will see
that e.g.
Bryce Verdier bryceverd...@gmail.com added the comment:
Is this more what was in mind for the bug?
--
Added file: http://bugs.python.org/file22850/issue12301.test_patch
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue12301
Terry J. Reedy tjre...@udel.edu added the comment:
I presume so. I believe ``x`` is meant for general code like ``for thing in
group: print(thing)``. While Éric specifically mentioned the :data: role, I
presume the same idea applies to :func: and possibly other link-generating
roles.
Is
Ezio Melotti ezio.melo...@gmail.com added the comment:
For global there's :keyword:. Also note that :data: should be used for
module-level variables (or constant) not for attributes of e.g. classes and
instances.
If there are other ``...`` that can be fixed (even using something else like
Ezio Melotti ezio.melo...@gmail.com added the comment:
+1
--
keywords: +easy
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue12301
___
___
Terry J. Reedy tjre...@udel.edu added the comment:
Links are good ;-).
--
nosy: +terry.reedy
stage: - needs patch
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue12301
___
New submission from Éric Araujo mer...@netwok.org:
In a great number of files, the ``code`` markup is used instead of the :data:
role, which would create a link to the appropriate definition.
Unless someone objects, I would like to change all of them.
--
assignee: eric.araujo
Changes by Ezio Melotti ezio.melo...@gmail.com:
--
nosy: +ezio.melotti
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue12301
___
___
15 matches
Mail list logo
