[issue45762] Missing `list` symbols in the object inventory

[Éric Araujo]

Éric Araujo  added the comment:

If you search in the index, there is no entry like 'append (list method)', only 
'append (sequence method)': https://docs.python.org/3/genindex-A.html
This goes to the reference docs, where list methods are documented indirectly 
by reference to the Sequence protocol described just above the list section: 
https://docs.python.org/3/library/stdtypes.html#lists

The tutorial page lists all methods for people learning, with noindex markup to 
avoid pointing from the index to the reference: 
https://github.com/python/cpython/blob/3.10/Doc/tutorial/datastructures.rst#L19

The individual decisions make sense, but I think the results is not 
satisfactory: there is no reference to list.append (etc) in the index or the 
sphinx inventory (only 'list.sort' is there, from the entry in the 
library/stdtypes list section).  I think index markup should be added for all 
built-in types in the stdtypes page so that links are generated.  
Alternatively, add a sphinx directive to register that a type matches the 
sequence (etc) protocol, so that index entries for all protocol methods can be 
generated automatically.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue45762] Missing `list` symbols in the object inventory

[Terry J. Reedy]

Change by Terry J. Reedy :


--
nosy: +eric.araujo, ezio.melotti, mdk, willingc
versions:  -Python 3.10, Python 3.6, Python 3.7, Python 3.8, Python 3.9

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue45762] Missing `list` symbols in the object inventory

[Matteo Bertucci]

New submission from Matteo Bertucci :

Sphinx generates a quite useful inventory file, listing all the different 
symbols available inside the documentation. You can find the docs.python.org 
inventory over at https://docs.python.org/objects.inv. The syntax of this file 
can be found here https://sphobjinv.readthedocs.io/en/latest/syntax.html.

We use it over at Python Discord to power up our `!docs` command. It allows us 
to look up symbols such as `asyncio.run`, have nicely formatted documentation 
and links to the web page. 

The problem is due to where the `list` method documentations are located, 
inside `/tutorial/datastructures` 
(https://docs.python.org/3/tutorial/datastructures.html), no symbol is exported 
for those, making commands such as `!docs list.append` fail, which is quite a 
bummer. It would be very nice to have access to those.

--
assignee: docs@python
components: Documentation
messages: 406004
nosy: Akarys, docs@python
priority: normal
severity: normal
status: open
title: Missing `list` symbols in the object inventory
versions: Python 3.10, Python 3.11, Python 3.6, Python 3.7, Python 3.8, Python 
3.9

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com