[issue10617] Collections ABCs can’t be linked to

Éric Araujo added the comment: Thanks Ezio. -- ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.pyt

[issue10617] Collections ABCs can’t be linked to

Changes by Ezio Melotti : -- resolution: -> fixed stage: patch review -> committed/rejected status: open -> closed ___ Python tracker ___ ___

[issue10617] Collections ABCs can’t be linked to

Roundup Robot added the comment: New changeset c5de208d205c by Ezio Melotti in branch '3.1': #10617: add class directives to collections ABCs. http://hg.python.org/cpython/rev/c5de208d205c New changeset 3daca2b76297 by Ezio Melotti in branch '3.2': #10617: merge with 3.1. http://hg.python.org/c

[issue10617] Collections ABCs can’t be linked to

Roundup Robot added the comment: New changeset cc04b591d768 by Ezio Melotti in branch '2.7': #10617: add class directives to collections ABCs. http://hg.python.org/cpython/rev/cc04b591d768 -- nosy: +python-dev ___ Python tracker

[issue10617] Collections ABCs can’t be linked to

Éric Araujo added the comment: What about making the class names in the table not links? -- ___ Python tracker ___ ___ Python-bugs-li

[issue10617] Collections ABCs can’t be linked to

Changes by Ezio Melotti : Added file: http://bugs.python.org/file21395/10617-2.png ___ Python tracker ___ ___ Python-bugs-list mailing list Un

[issue10617] Collections ABCs can’t be linked to

Ezio Melotti added the comment: I put the list under the table and grouped a few more ABCs. If this patch is OK I'll commit it. -- Added file: http://bugs.python.org/file21394/issue10617-2.diff ___ Python tracker

[issue10617] Collections ABCs can’t be linked to

Éric Araujo added the comment: > I didn't include the () after the methods name because [...] they look > ugly on the special __methods__() and it's clear that they are methods > even without the (). I feel that way for all functions and methods in the docs, especially given Python’s distincti

[issue10617] Collections ABCs can’t be linked to

Ezio Melotti added the comment: I put the list first and table second because the table contains more details and information, whereas the list only has a short description (usually the tables provide an overview and they are followed by a more comprehensive list). I didn't include the () afte

[issue10617] Collections ABCs can’t be linked to

Georg Brandl added the comment: BTW: :meth:`x ` should not do anything different from :meth:`x`. -- ___ Python tracker ___ ___ Python

[issue10617] Collections ABCs can’t be linked to

Georg Brandl added the comment: Yes; then the table entries will link to the descriptions below. -- ___ Python tracker ___ ___ Python

[issue10617] Collections ABCs can’t be linked to

Raymond Hettinger added the comment: This looks fine, but it may be better to put the tables first and details second. -- ___ Python tracker ___ ___

[issue10617] Collections ABCs can’t be linked to

Ezio Melotti added the comment: Here's a patch that adds the list of classes with a minimal description before the table. I grouped a few classes to save some space. Container, Hashable, Sized, Callable could be grouped too. I also added links to the methods and to glossary terms (the `set` te

[issue10617] Collections ABCs can’t be linked to

Georg Brandl added the comment: I would recommend to document the classes like all other classes. It may take a bit more space, but it will be a) standard and b) linkable. -- ___ Python tracker _

[issue10617] Collections ABCs can’t be linked to

Raymond Hettinger added the comment: Georg, do you have a recommendation? -- assignee: docs@python -> georg.brandl nosy: +rhettinger ___ Python tracker ___ _

[issue10617] Collections ABCs can’t be linked to

Ezio Melotti added the comment: Apparently there's no way to change the text generated by the "class" directive, so it's not possible to use it in the table without having the "class" before the names. The alternatives are: 1) define these classes normally instead of or in addition to the tab

[issue10617] Collections ABCs can’t be linked to

Changes by Ezio Melotti : -- nosy: +ezio.melotti ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.py

[issue10617] Collections ABCs can’t be linked to

Éric Araujo added the comment: I don’t either. The one thing I’d like is that :class:`collections.Set` generates a link to the table which documents the ABCs. -- nosy: +georg.brandl ___ Python tracker __

[issue10617] Collections ABCs can’t be linked to

Sandro Tosi added the comment: but that will generate "class collections.abc.Container" as text in the first column of the table: do you really like it? I don't :) -- ___ Python tracker __

[issue10617] Collections ABCs can’t be linked to

Éric Araujo added the comment: Doc moved: correct. Changing roles to directives: yes, that’s what I meant. -- ___ Python tracker ___ ___

[issue10617] Collections ABCs can’t be linked to

Sandro Tosi added the comment: Hi Éric, after #11085, I think the part of the doc you're referring to has been moved to collections.abc.rst, is that correct? If so, can you please explain what you'd like to see? all those ":class:`Container`" converted into ".. class:: Container" in the table

[issue10617] Collections ABCs can’t be linked to

New submission from Éric Araujo : ABCs in collections.rst are marked up with a class role, not a class directive, which means that constructs using the class role do not generate a link. -- assignee: d...@python components: Documentation messages: 123277 nosy: d...@python, eric.araujo p