Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
anntzer opened this issue Jan 3, 2017 · 0 comments
Open

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

anntzer opened this issue Jan 3, 2017 · 0 comments

Comments

@anntzer
Copy link
Contributor

anntzer commented Jan 3, 2017

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.

@minrk minrk modified the milestone: 5.0 Jun 6, 2017
@Carreau Carreau modified the milestones: 5.0, 5.1 Jun 22, 2020
@Carreau Carreau removed this from the 5.1 milestone Aug 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants