docs: improve explanation of the `errors` argument of `urllib.parse` functions
オープン
まだ誰も着手していません。
docs
- 主要言語
- Python
- スター
- 77.2k
- フォーク
- 35.9k
- PR マージ指標
- PR 指標を取得中
説明
Documentation
The URL quoting/unquoting functions in urllib.parse all have an errors argument, which is passed on to internal encode and decode functions.
The full explanation of what errors means is only explained in urllib.parse.quote.
The documentation for the other functions explains the the default behavior, but not any alternatives.
Each other function's documentation should should point to urllib.parse.quote for an explanation of errors.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
urllib.parse の quote と、その他の URL のクォートおよびアン クォートを行う関数についてのドキュメントを読みます。quote の errors 引数について既にある説明を参照し、その後、他の各関数がその説明を参照するようにして、リンクと文言を確認するために関連するドキュメントビルドを実行します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 55/100