Bug 457176

Summary: No API documentation for HolidayRegion::rawHolidaysWithAstroSeasons()
Product: [Frameworks and Libraries] frameworks-kholidays Reporter: David Jarvie <djarvie>
Component: generalAssignee: kdepim bugs <pim-bugs-null>
Status: RESOLVED FIXED    
Severity: normal CC: a.samirh78, nate, spitz234
Priority: NOR    
Version First Reported In: 5.96.0   
Target Milestone: ---   
Platform: Other   
OS: Linux   
Latest Commit: https://invent.kde.org/frameworks/kholidays/-/commit/967e61c3db30d75df70356099eb9b3984e89bd5d Version Fixed/Implemented In: 6.8.0
Sentry Crash Report:

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