python / python/cpython

Improve section "Data Structures" in the tutorial

未关闭
#146,487 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

3.13 3.14 3.15 docs
主要语言
Python
星标
77.2k
派生
35.9k
PR 合并指标
PR 指标待抓取

描述

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

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 Doc/tutorial/datastructures.rst 及其 "More on Lists" 子节开始,然后将正式的方法描述与库参考文档中的对应描述进行比较。查看最近的讨论以了解上下文;完成的标准是教程避免不必要的重复定义,同时保留指向实际描述的有效引用。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
冷清
描述清晰度
基本清楚
新手友好度
58/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。