python / python/cpython

Docs: inline markup in `c-api/typeobj.rst` legend is not rendered because of `.. code-block:: none`

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

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

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

説明

Documentation

In Doc/c-api/typeobj.rst, the two legends that explain the "D" (default) and "I" (inheritance) columns of the PyTypeObject quick-reference table (lines 172–187) are wrapped in .. code-block:: none. Because code-block renders its content verbatim:

  • *PyType_Ready* and *NULL* appear with literal asterisks.
  • PyType_Ready is plain text instead of a cross-reference to :c:func:PyType_Ready.
  • NULL is plain text instead of the NULL inline literal used elsewhere in the same file.
Image
Linked PRs
  • gh-148962

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

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

はじめの一歩

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

調査の方向性

Doc/c-api/typeobj.rst を開き、172–187 行付近にある 2 つの legend を調べてください。ファイル内の別の箇所で、レンダリングされたドキュメントが PyType_Ready の相互参照とインラインリテラル NULL をどのように扱っているか確認してください。両方の legend がリテラルのアスタリスクではなく markup をレンダリングし、意図した参照とリテラルのフォーマットになることが完了条件です。

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

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
1/5
見積もり時間
1時間未満
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
25/100

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

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