ipython / ipython/traitlets

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

Aperta
#357 0 commenti 1 reazione 0 assegnatari Vedi su GitHub
good first issue
Lingua principale
Python
Stelle
653
Fork
217
Merge medio
2g 21h
PR unite (30g)
2

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.