ipython / ipython/traitlets

document min, max kwargs to traitlets.{Int,Float}

Offen
#357 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
good first issue
Vorherrschende Sprache
Python
Sterne
653
Forks
217
Ø Merge
2 T. 21 Std.
Gemergte PRs (30 T.)
2

Beschreibung

The `min` and `max` kwargs are "manually" implemented as kw-only args to `Int` and `Float`. As a consequence, they do not appear in the generated docs (https://traitlets.readthedocs.io/en/stable/trait_types.html#numbers) anywhere AFAICT. I think sphinx allows manually overriding the signature to e.g. use the Python3-format (`Int(default_value=Undefined, allow_none=False, *, min=None, max=None, **kwargs)`) in the docs.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Start with the generated Numbers section at traitlets.readthedocs.io/en/stable/trait_types.html#numbers and inspect how Sphinx derives the Int and Float signatures. Update the documentation so the min and max keyword-only arguments are visible, then rebuild or review the generated page to confirm both signatures include them.

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
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

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