python / python/cpython

urllib.parse - quote/unquote documentation issues

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

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

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

説明

https://docs.python.org/3/library/urllib.parse.html

  1. It's my understanding that the arguement in the displayed usage shows the default. So:
    urllib.parse.quote(string, safe='/', encoding=None, errors=None)
    means that errors defaults to NoneType, however, the documentation just below that says:

"errors defaults to 'strict'

  1. quote: There isn't a list of possible values for the "errors" argument

  2. unquote - There isn't a list of possible values for the "errors" argument

  3. unquote -

errors defaults to 'replace', meaning invalid sequences are replaced by a placeholder character.

What "placeholder character" is it that's used?

  1. unquote

encoding defaults to 'utf-8'. errors defaults to 'replace', meaning invalid sequences are replaced by a placeholder character.

Is a single line. errors should be on a new line (all arguements for all functions really should always be on a new line unless there's a compelling reason not to. To do otherwise significantly impedes readability, while increasing the chances of misunderstanding).

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

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

はじめの一歩

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

調査の方向性

リンク先の urllib.parse ドキュメントページから始め、quote と unquote のシグネチャおよび周辺パラメーターの説明を確認してください。報告されているデフォルト値、errors の値の一覧、プレースホルダー文字の説明、書式上の問題を解決し、各関数の引数と動作がページに明確に記載されるようにしてください。

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

評価

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

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

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