[issue21352] improve indexing
New submission from bob gailer:
Inconsistencies / confusion with documentation Index Tab. Example (line numbers added for comments that follow):
1 max
2 built-in function
3 max (datetime.date attribute)
4 (datetime.datetime attribute)
5 (datetime.time attribute)
6 max() built-in function
7 (decimal.Context method)
8 (decimal.Decimal method)
9 (in module audioloop)
The following all lead to confusion and frustration:
Having 3 rows (1, 3, 6)that begin with max.
Having an entry (1) that does nothing when double-clicked.
double-clicking (2) takes us to a reference rather than a definition.
RECOMMENDATION:
change to:
max() built-in function
(sequence operation)
(decimal.Context method)
(decimal.Decimal method)
max
(datetime.date attribute)
(datetime.datetime attribute)
(datetime.time attribute)
where double-clicking the first line goes to the max() definition
in 2. Built-in Functions
These comments apply, with a number of variations, to most built-in functions index entries.
----------
assignee: docs@python
components: Documentation
messages: 217170
nosy: bgailer, docs@python
priority: normal
severity: normal
status: open
title: improve indexing
type: enhancement
versions: Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4, Python 3.5
_______________________________________
Python tracker
Changes by Zachary Ware
Changes by Antoine Pitrou
Changes by Terry J. Reedy
Éric Araujo added the comment:
I have to agree the index pages are often frustrating for me too.
Not sure if this involves code changes in Sphinx itself or if we can improve the markup in the Python docs sources.
----------
nosy: +eric.araujo
_______________________________________
Python tracker
Changes by Tshepang Lekhonkhobe
Change by Irit Katriel
participants (7)
-
Antoine Pitrou
-
bob gailer
-
Irit Katriel
-
Terry J. Reedy
-
Tshepang Lekhonkhobe
-
Zachary Ware
-
Éric Araujo