Bug 457176 - No API documentation for HolidayRegion::rawHolidaysWithAstroSeasons()
Summary: No API documentation for HolidayRegion::rawHolidaysWithAstroSeasons()
Status: RESOLVED FIXED
Alias: None
Product: frameworks-kholidays
Classification: Frameworks and Libraries
Component: general (show other bugs)
Version: 5.96.0
Platform: Other Linux
: NOR normal
Target Milestone: ---
Assignee: kdepim bugs
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-07-26 22:17 UTC by David Jarvie
Modified: 2024-11-05 10:53 UTC (History)
3 users (show)

See Also:
Latest Commit: https://invent.kde.org/frameworks/kholidays/-/commit/967e61c3db30d75df70356099eb9b3984e89bd5d
Version Fixed In: 6.8.0
Sentry Crash Report:

Attachments
Add an attachment

Note You need to log in before you can comment on or make changes to this bug.
Description David Jarvie 2022-07-26 22:17:08 UTC 
There is nothing in the API documentation to indicate what HolidayRegion::rawHolidaysWithAstroSeasons() is for, as compared to HolidayRegion::rawHolidays() - the API description for the two methods is identical. The name rawHolidaysWithAstroSeasons doesn't mean anything to me, so a description is necessary.

Looking at the autotest/testholidayregion.cpp code, it seems, counter-intuitively, that rawHolidaysWithAstroSeasons() is functionally equivalent to the deprecated holidays() function. Rather, I would have expected that rawHolidays() would now be equivalent to holidays().

Please include descriptions for rawHolidaysWithAstroSeasons() and rawHolidays() which makes clear what each is actually for.

SOFTWARE/OS VERSIONS
KDE Frameworks Version: 5.97.0