This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Links on top of collections doc not in the order of sections
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.11, Python 3.10
process
Status: closed Resolution: rejected
Dependencies: Superseder:
Assigned To: rhettinger Nosy List: andrei.avk, docs@python, rhettinger
Priority: low Keywords:

Created on 2021-06-01 20:16 by andrei.avk, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Messages (2)
msg394867 - (view) Author: Andrei Kulakov (andrei.avk) * (Python triager) Date: 2021-06-01 20:16
https://docs.python.org/3.11/library/collections.html

Links are not in the same order as the sections below. It creates some dissonance for the reader to first read the section names above and then continue reading expecting them to be in the same order through the page.

Seems like would be an easy fix to reorder them.
msg394880 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2021-06-02 00:17
ISTM that the table order doesn't need to match because the links take you directly to the section of interest.  They make it so that you don't need to know the order of sections below.  Currently, they have a "logical" grouping with the two sequence-like objects side-by-side, the four dict or dict-like subclasses side-by-side, and the other "User" classes side-by-side.

The order of the sections below is in alpha order (with the minor exception of deque and defaultdict being swapped).  This is also reasonable because a person would likely be scanning the Table of Contents looking for the class or function by its name.

This is really no different than a lending library having a title catalog and a subject catalog with the same information arranged in two different ways.  Both ways have value.

Thank you for the suggestion, but the existing ordering was intentional and is useful.  Possibly, we could swap the *deque* and *defaultdict* sections, but the benefit is very minor and likely isn't worth the churn.
History
Date User Action Args
2022-04-11 14:59:46adminsetgithub: 88447
2021-06-02 00:18:00rhettingersetstatus: open -> closed
resolution: rejected
messages: + msg394880

stage: resolved
2021-06-02 00:03:18rhettingersetpriority: normal -> low
2021-06-02 00:03:11rhettingersetassignee: docs@python -> rhettinger

nosy: + rhettinger
versions: - Python 3.9
2021-06-01 20:16:59andrei.avkcreate