ipython / ipython/traitlets

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

Open
#357 0 comments 1 reaction 0 assignees View on GitHub
good first issue
Dominant language
Python
Stars
653
Forks
217
Avg merge
2d 21h
Merged PRs (30d)
2

Description

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.