python / python/cpython

Improve section "Data Structures" in the tutorial

オープン
#146,487 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

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. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

Doc/tutorial/datastructures.rst とその "More on Lists" サブセクションから始め、続いて正式なメソッドの説明をライブラリリファレンス側の対応する説明と比較してください。文脈を把握するために最近の議論を確認してください。チュートリアルが不要な重複定義を避けつつ、実際の説明への有効な参照を維持できていれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
静か
明瞭さ
おおむね明確
初心者へのやさしさ
58/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。