Skip to content

Commit 37d8623

Browse files
committed
Adjustments and documentation suggested by @coderabbitai
1 parent 2368f2e commit 37d8623

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

src/undate/converters/edtf/converter.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@
1313

1414

1515
class EDTFDateConverter(BaseDateConverter):
16+
"""
17+
Converter for Extended Date/Time Format (EDTF).
18+
19+
Supports parsing and serializing dates and date ranges in EDTF format.
20+
Does not support all of EDTF, and only supports dates and not times.
21+
"""
22+
1623
#: converter name: EDTF
1724
name: str = "EDTF"
1825

src/undate/undate.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
class Undate:
1313
"""object for representing uncertain, fuzzy or partially unknown dates"""
1414

15-
DEFAULT_FORMAT: str = "ISO8601"
15+
DEFAULT_CONVERTER: str = "ISO8601"
1616

1717
#: symbol for unknown digits within a date value
1818
MISSING_DIGIT: str = "X"
@@ -138,7 +138,7 @@ def __init__(
138138
if converter is None:
139139
# import all subclass definitions; initialize the default
140140
converter_cls = BaseDateConverter.available_converters()[
141-
self.DEFAULT_FORMAT
141+
self.DEFAULT_CONVERTER
142142
]
143143
converter = converter_cls()
144144
self.converter = converter

0 commit comments

Comments
 (0)