Skip to content

Commit 04f8b65

Browse files
committed
Update documentation to match current functionality
1 parent 4d0b488 commit 04f8b65

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
**undate** is a python library for working with uncertain or partially known dates.
66

77
> [!WARNING]
8-
> This is pre-alpha software and is **NOT** feature complete! Use with caution.
9-
> Currently it only supports parsing and formatting dates in ISO8601 format and
10-
> some portions of EDTF (Extended Date Time Format).
8+
> This is alpha software and is not yet feature complete! Use with caution and give us feedback.
9+
> Currently `undate` supports parsing and formatting dates in ISO8601, some
10+
portions of EDTF (Extended Date Time Format), and parsing and conversion for dates in Hebrew Anno Mundi and Islamic Hijri calendars
1111

1212
*Undate was initially created as part of a [DH-Tech](https://dh-tech.github.io/) hackathon in November 2022.*
1313

@@ -167,9 +167,9 @@ Dates are stored with the year, month, day and appropriate precision for the ori
167167
>>> tammuz4816 = Undate.parse("26 Tammuz 4816", "Hebrew")
168168
>>> tammuz4816
169169
<Undate '26 Tammuz 4816 Anno Mundi' 4816-04-26 (Hebrew)>
170-
>>> rajab495 = Undate.parse("Rajab 495", "Hijri")
170+
>>> rajab495 = Undate.parse("Rajab 495", "Islamic")
171171
>>> rajab495
172-
<Undate 'Rajab 495 Hijrī' 0495-07 (Hijri)>
172+
<Undate 'Rajab 495 Hijrī' 0495-07 (Islamic)>
173173
>>> y2k = Undate.parse("2001", "EDTF")
174174
>>> y2k
175175
<Undate 2001 (Gregorian)>
@@ -178,12 +178,12 @@ Dates are stored with the year, month, day and appropriate precision for the ori
178178
>>> [str(d.precision) for d in [rajab495, tammuz4816, y2k]]
179179
['MONTH', 'DAY', 'YEAR']
180180
>>> sorted([rajab495, tammuz4816, y2k])
181-
[<Undate '26 Tammuz 4816 Anno Mundi' 4816-04-26 (Hebrew)>, <Undate 'Rajab 495 Hijrī' 0495-07 (Hijri)>, <Undate 2001 (Gregorian)>]
181+
[<Undate '26 Tammuz 4816 Anno Mundi' 4816-04-26 (Hebrew)>, <Undate 'Rajab 495 Hijrī' 0495-07 (Islamic)>, <Undate 2001 (Gregorian)>]
182182
```
183183

184184
* * *
185185

186-
For more examples, refer to the [example notebooks](https://github.com/dh-tech/undate-python/tree/main/examples/notebooks/) included in this repository.
186+
For more examples, refer to the code notebooks included in the [examples](https://github.com/dh-tech/undate-python/tree/main/examples/) in this repository.
187187

188188
## Documentation
189189

src/undate/undate.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -368,8 +368,9 @@ def to_undate(cls, other: object) -> "Undate":
368368
"""Convert arbitrary object to Undate, if possible. Raises TypeError
369369
if conversion is not possible.
370370
371-
Currently suppports:
371+
Currently supports:
372372
- :class:`datetime.date` or :class:`datetime.datetime`
373+
- :class:`undate.date.Date`
373374
374375
"""
375376
match other:

0 commit comments

Comments
 (0)