Skip to content

Commit d657df2

Browse files
fix docu for zeitraum (#972)
* fix docu for zeitraum * add examples for each property * bring back startuhrzeit * improve docs --------- Co-authored-by: Annika <73470827+hf-aschloegl@users.noreply.github.com>
1 parent b2857c1 commit d657df2

1 file changed

Lines changed: 28 additions & 5 deletions

File tree

src/bo4e/com/zeitraum.py

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,35 @@ class Zeitraum(COM):
3333
"""
3434

3535
startdatum: Optional[date] = None
36-
"""Startdatum, inklusiv"""
36+
"""Startdatum des betrachteten Zeitraums ist **inklusiv**.
37+
38+
Example:
39+
'2025-01-01'
40+
"""
3741
enddatum: Optional[date] = None
38-
"""Enddatum, inklusiv"""
42+
"""Enddatum des betrachteten Zeitraums ist **inklusiv**.
43+
44+
Example:
45+
'2025-01-01'
46+
"""
3947
startuhrzeit: Optional[time] = None
40-
"""Startuhrzeit, inklusiv mit Zeitzone"""
48+
"""Startuhrzeit mit Zeitzone. Die angegebene Uhrzeit ist im betrachteten Zeitraum **inklusiv**.
49+
50+
Example:
51+
'18:00:00+01:00'
52+
"""
4153
enduhrzeit: Optional[time] = None
42-
"""Enduhrzeit, exklusiv mit Zeitzone"""
54+
"""Enduhrzeit mit Zeitzone. Die angegebene Uhrzeit ist im betrachteten Zeitraum **exklusiv**.
55+
56+
Example:
57+
'19:00:00+01:00'
58+
"""
4359
dauer: Optional[str] = None
44-
"""Dauer in ISO 8601 , example: 'P1DT30H4S', siehe https://datatracker.ietf.org/doc/html/rfc3339 """
60+
"""
61+
Dauer in ISO 8601 Format.
62+
63+
Example:
64+
'P1DT30H4S'
65+
66+
See `RFC 3339 <https://datatracker.ietf.org/doc/html/rfc3339>`_
67+
"""

0 commit comments

Comments
 (0)