python / python/cpython

Incorrect anchor tags generated in documentation

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

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

docs
主要言語
Python
スター
77.2k
フォーク
35.9k
PR マージ指標
PR 指標を取得中

説明

Documentation

I have spotted a couple of incorrect anchor links from the pilcrows in some docs pages. It looks like a the sphinx index directive and the headings should be swapped. I will create a pull request.

In The Python Language Reference » 6. Expressions » Identifiers (Names) the pilcrow links to #atom-identifiers instead of #identifiers-names.

In The Python Language Reference » 6. Expressions » Private name mangling the pilcrow links to #index-5 instead of #private-name-mangling.

In Python/C API reference manual » Concrete Objects Layer » MemoryView objects the pilcrow links to #index-0 instead of #memoryview-objects.

I have raised an issue rather than going straight for a PR because you might have concerns about breaking links?

Linked PRs
  • gh-155800

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

引用されている3つのPythonドキュメントページに対応するSphinxのインデックスディレクティブと見出しを確認し、その後、リンクされているPR gh-155800を調査します。完了とは、pilcrowアンカーが、意図しないリンク切れなしに、Identifiers (Names)、Private name mangling、MemoryView objectsの文書化された見出しアンカーへ解決されることを意味します。

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

評価

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

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

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