python / python/cpython

Python documentation in Texinfo format: Problems with `dircategory` and `direntry` commands

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

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

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

説明

Documentation

The Python documentation could be downloaded in Texinfo and Info format.
Which is great, I'm very very thankful for it.

But their is multiple problems, in the python.texi file, with the @dircategory and @direntry commands.

The @dircategory is now set to "Miscellaneous". It should be set to a more descriptive category. Like "Programming" or "Programming language" or "Python". A "Python" category could be re-used by other manuals related to Python. For example a manual for a Python framework or library.

In the @direntry command:

  • The info file name, in parenthesis, should not include the .info extension [1]
  • The menu entry description should be more descriptive than "One line description of project"

[1] https://www.gnu.org/software/texinfo/manual/texinfo/texinfo.html#Listing-a-New-Info-File

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

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

はじめの一歩

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

調査の方向性

python.texiを開いて、その@dircategoryおよび@direntryコマンドを確認し、現在の値をissueにリンクされたTexinfoのガイダンスと比較します。カテゴリが説明的であり、Infoファイル名から拡張子.infoが省略され、メニューの説明がプレースホルダーテキストを使用せずにPythonのドキュメントを示していれば完了です。

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

評価

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

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

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