Inconsistent description of `strict_optional`
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 20.6k
- Forks
- 3.3k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
Documentation
config_file.html says that "strict_optional {...} effectively disables checking of optional types and None values."
command_line.html says that "--no-strict-optional {...} effectively disables checking of optional types and None values."
Which is correct?
Additionally, the note "strict_optional=False is evil" (alternatively "--no-strict-optional is evil") is not terribly helpful for debugging a system which already uses these settings - a link to further info would be useful.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Prüfe zuerst die verlinkten Abschnitte None und Optional Handling in config_file.html und command_line.html. Gleiche die Beschreibungen von strict_optional und --no-strict-optional ab und verbessere anschließend den Hinweis „strict_optional=False is evil“ mit einem Link zu weiterführenden Informationen. Erledigt ist die Aufgabe, wenn beide Seiten die Einstellung konsistent beschreiben und Hinweise zur Fehlersuche geben.
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
- Ruhig
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 72/100