Skip to content

Improve section "Data Structures" in the tutorial #146487

@serhiy-storchaka

Description

@serhiy-storchaka

Documentation

The "More on Lists" subsection in the "Data Structures" section (Doc/tutorial/datastructures.rst) is the only place in the tutorial that contains formal definitions using Sphinx directives. They mostly duplicate descriptions in the library reference, and index entries refer to ones in the library reference, not in the tutorial. The list class is the only class whose methods are described so in the tutorial. The tutorial perhaps do not need such formal descriptions of all these methods. We could do like with other builtin functions and methods of other builtin classes, and simply add references to their real descriptions.

References to many methods of built classes did not work until recently. This might be one of reasons of exisiting such section.

This was discussed in https://discuss.python.org/t/a-small-typo-on-5-1-more-on-lists-section/106150. cc @nedbat

Metadata

Metadata

Assignees

No one assigned

    Labels

    3.13bugs and security fixes3.14bugs and security fixes3.15new features, bugs and security fixesdocsDocumentation in the Doc dir

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions