Skip to content

Document Int and Float bounds #991

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.

Sign up for GitHub

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

Open
nightcityblade wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −2
Open

Document Int and Float bounds #991

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions traitlets/traitlets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2607,7 +2607,15 @@ def _validate_bounds(


class Int(TraitType[G, S]):
"""An integer trait."""
"""An integer trait.

Parameters
----------
min : int or None, optional
Inclusive lower bound. If ``None``, no lower bound is enforced.
max : int or None, optional
Inclusive upper bound. If ``None``, no upper bound is enforced.
"""

default_value = 0
info_text = "an int"
Expand Down Expand Up @@ -2760,7 +2768,15 @@ def __init__(self, *args: t.Any, **kwargs: t.Any) -> None:


class Float(TraitType[G, S]):
"""A float trait."""
"""A float trait.

Parameters
----------
min : float, optional
Inclusive lower bound. Defaults to negative infinity.
max : float, optional
Inclusive upper bound. Defaults to positive infinity.
"""

default_value = 0.0
info_text = "a float"
Expand Down
Loading