python / python/cpython

docs: improve explanation of the `errors` argument of `urllib.parse` functions

Offen
#125,188 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

docs
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
35.9k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Lies die Dokumentation von urllib.parse zu quote und den anderen Funktionen zum Quoten und Unquoten von URLs. Verwende die bestehende Erklärung des Arguments errors in quote als Referenz. Stelle dann sicher, dass jede andere Funktion darauf verweist, und führe den relevanten Dokumentations-Build aus, um die Links und die Formulierung zu überprüfen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
55/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.