From 4df89cb84cd5067fed6b003fb869a67988fec7c1 Mon Sep 17 00:00:00 2001 From: kevin Date: Thu, 20 Mar 2025 11:58:31 +0100 Subject: [PATCH 1/4] fix docu for zeitraum --- src/bo4e/com/zeitraum.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/bo4e/com/zeitraum.py b/src/bo4e/com/zeitraum.py index 3495c5157..f6de772ad 100644 --- a/src/bo4e/com/zeitraum.py +++ b/src/bo4e/com/zeitraum.py @@ -41,4 +41,11 @@ class Zeitraum(COM): enduhrzeit: Optional[time] = None """Enduhrzeit, exklusiv mit Zeitzone""" dauer: Optional[str] = None - """Dauer in ISO 8601 , example: 'P1DT30H4S', siehe https://datatracker.ietf.org/doc/html/rfc3339 """ + """ + Dauer in ISO 8601 Format. + + Example: + 'P1DT30H4S' + + See `RFC 3339 `_ + """ From 57e11507c3355cd58053843f3b4c0b1b2358ce1b Mon Sep 17 00:00:00 2001 From: kevin Date: Thu, 20 Mar 2025 12:04:08 +0100 Subject: [PATCH 2/4] add examples for each property --- src/bo4e/com/zeitraum.py | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/src/bo4e/com/zeitraum.py b/src/bo4e/com/zeitraum.py index f6de772ad..c9dc19e95 100644 --- a/src/bo4e/com/zeitraum.py +++ b/src/bo4e/com/zeitraum.py @@ -33,13 +33,23 @@ class Zeitraum(COM): """ startdatum: Optional[date] = None - """Startdatum, inklusiv""" + """Startdatum, inklusiv + + Example: + '2025-01-01' + """ enddatum: Optional[date] = None - """Enddatum, inklusiv""" - startuhrzeit: Optional[time] = None - """Startuhrzeit, inklusiv mit Zeitzone""" + """Enddatum, inklusiv + + Example: + '2025-01-01' + """ enduhrzeit: Optional[time] = None - """Enduhrzeit, exklusiv mit Zeitzone""" + """Enduhrzeit, exklusiv mit Zeitzone + + Example: + '19:00:00+01:00' + """ dauer: Optional[str] = None """ Dauer in ISO 8601 Format. From be76c71832f0f5a24badf383a336380fcd97ba66 Mon Sep 17 00:00:00 2001 From: kevin Date: Thu, 20 Mar 2025 12:08:42 +0100 Subject: [PATCH 3/4] bring back startuhrzeit --- src/bo4e/com/zeitraum.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/bo4e/com/zeitraum.py b/src/bo4e/com/zeitraum.py index c9dc19e95..4f9e11640 100644 --- a/src/bo4e/com/zeitraum.py +++ b/src/bo4e/com/zeitraum.py @@ -44,6 +44,12 @@ class Zeitraum(COM): Example: '2025-01-01' """ + startuhrzeit: Optional[time] = None + """Startuhrzeit, inklusiv mit Zeitzone + + Example: + '18:00:00+01:00' + """ enduhrzeit: Optional[time] = None """Enduhrzeit, exklusiv mit Zeitzone From 6ed07a8f9640ce6a79b3df549e47c66b8ee14679 Mon Sep 17 00:00:00 2001 From: kevin Date: Thu, 20 Mar 2025 12:54:49 +0100 Subject: [PATCH 4/4] improve docs --- src/bo4e/com/zeitraum.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/bo4e/com/zeitraum.py b/src/bo4e/com/zeitraum.py index 4f9e11640..7b0961260 100644 --- a/src/bo4e/com/zeitraum.py +++ b/src/bo4e/com/zeitraum.py @@ -33,25 +33,25 @@ class Zeitraum(COM): """ startdatum: Optional[date] = None - """Startdatum, inklusiv + """Startdatum des betrachteten Zeitraums ist **inklusiv**. Example: '2025-01-01' """ enddatum: Optional[date] = None - """Enddatum, inklusiv + """Enddatum des betrachteten Zeitraums ist **inklusiv**. Example: '2025-01-01' """ startuhrzeit: Optional[time] = None - """Startuhrzeit, inklusiv mit Zeitzone + """Startuhrzeit mit Zeitzone. Die angegebene Uhrzeit ist im betrachteten Zeitraum **inklusiv**. Example: '18:00:00+01:00' """ enduhrzeit: Optional[time] = None - """Enduhrzeit, exklusiv mit Zeitzone + """Enduhrzeit mit Zeitzone. Die angegebene Uhrzeit ist im betrachteten Zeitraum **exklusiv**. Example: '19:00:00+01:00'