python / python/cpython

Slash notation should be defined in a notation key at the beginning of the Built-In Functions section

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

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

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

説明

Documentation

The Standard Library defines a number of built-in functions, and a shorthand notation is used when a function is defined, such as the definition of repr:

repr(object, /)

But there is no information about what that "/' means in the function signature. It is not standard computer science notation, so I started looking for its meaning. Normally, a notation key should be at the beginning of the document or section, but I do not find a notation key either at the beginning of the section or at the beginning of the documentation.

Could a notation key be added please, to define the meaning of this and any other non-standard notation that is used in the Python documentation?

Linked PRs
  • gh-142641

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

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

はじめの一歩

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

調査の方向性

Python Standard Library documentation の「Built-in Functions」セクションから始め、repr(object, /) 周辺の関数シグネチャ表記を確認します。スラッシュと、そこで特定したその他の標準外の表記を説明する表記キーを追加します。読者が別の場所を検索せずにこれらのシグネチャを理解できるようになった時点で、ドキュメントは完成です。

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

評価

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

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

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