Skip to content

Commit

Permalink
Merge pull request #203 from hf-kklein/patch-6
Browse files Browse the repository at this point in the history
docs: be more clear about different kind of `is_werktag`-style functions
  • Loading branch information
mj0nez authored Jan 14, 2025
2 parents 2937be0 + 9c31bef commit a3399e3
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ pip install bdew-datetimes
```

### Check if a date is a _specific_ BDEW Holidays
> [!NOTE]
By "specific" we mean: Holidays that are neither nation- nor statewide holidays (those are defined in the [upstream package holidays](https://github.com/vacanza/holidays)) but defined by the BDEW directly.
In 2025 those are: Sonderfeiertag 24h Lieferantenwechsel, Heiligabend and Silvester only.

The `HolidaySum` returned by `create_bdew_calendar` contains the BDEW specific holidays.
This means it contains those holidays which are _defined_ by BDEW which includes Heiligabend and Silvester as well as special days without Marktkommunikation but _not_ the local or nationwide holidays in Germany and its states.
Expand All @@ -46,7 +49,7 @@ The **union** (type `HolidaySum`) of both nation and state wide holidays **and**

### Check if a given Date is a BDEW Working Day
BDEW working days are those days taken into account for the "Fristenberechnung".
The function `is_bdew_working_day` considers both national and state wide holidays as well as BDEW holidays:
The function `is_bdew_working_day` considers both national **and** state wide holidays **and** BDEW holidays:
```python
from datetime import date

Expand Down

0 comments on commit a3399e3

Please sign in to comment.