Skip to content

Commit e80c7d5

Browse files
Callum027Callum Dickinson
andauthored
Add missing notes for expiry_date changes (#34)
Co-authored-by: Callum Dickinson <callum.dickinson@catalystcloud.nz>
1 parent 7eda614 commit e80c7d5

4 files changed

Lines changed: 16 additions & 2 deletions

File tree

docs/managers/credit.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,9 @@ expiry_date: date | Literal[False]
9191

9292
The date the credit expires, if an expiry date is set.
9393

94+
*Changed in version 0.2.6*: Fixed incorrect annotation for `expiry_date`
95+
by marking it as optional.
96+
9497
### `initial_balance`
9598

9699
```python

docs/managers/grant.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ expiry_date: date | Literal[False]
5656

5757
The date the grant expires, if an expiry date is set.
5858

59+
*Changed in version 0.2.6*: Fixed incorrect annotation for `expiry_date`
60+
by marking it as optional.
61+
5962
### `grant_type_id`
6063

6164
```python

openstack_odooclient/managers/credit.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,11 @@ class Credit(RecordBase["CreditManager"]):
4141
"""The current remaining balance on the credit."""
4242

4343
expiry_date: date | Literal[False]
44-
"""The date the credit expires, if an expiry date is set."""
44+
"""The date the credit expires, if an expiry date is set.
45+
46+
*Changed in version 0.2.6*: Fixed incorrect annotation for ``expiry_date``
47+
by marking it as optional.
48+
"""
4549

4650
initial_balance: float
4751
"""The initial balance this credit started off with."""

openstack_odooclient/managers/grant.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,11 @@
2525

2626
class Grant(RecordBase["GrantManager"]):
2727
expiry_date: date | Literal[False]
28-
"""The date the grant expires, if an expiry date is set."""
28+
"""The date the grant expires, if an expiry date is set.
29+
30+
*Changed in version 0.2.6*: Fixed incorrect annotation for ``expiry_date``
31+
by marking it as optional.
32+
"""
2933

3034
grant_type_id: Annotated[int, ModelRef("grant_type", GrantType)]
3135
"""The ID of the type of this grant."""

0 commit comments

Comments
 (0)