Skip to content

Commit 4e5b243

Browse files
committed
Add a docstring describing UnInlt
1 parent 0ea001e commit 4e5b243

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

src/undate/date.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,13 @@ def days(self) -> int:
3333

3434
@dataclass
3535
class UnInt:
36+
"""An uncertain integer intended for use with uncertain durations (:class:`UnDelta`),
37+
to convey a range of possible integer values between an upper
38+
and lower bound (inclusive). Supports comparison, addition and subtraction,
39+
checking if a value is included in the range, and iterating over numbers
40+
included in the range.
41+
"""
42+
3643
lower: int
3744
upper: int
3845

0 commit comments

Comments
 (0)