Repository navigation
docs: clarify new() docstrings of Alarm, Availability, Available and Todo - #1800
sandeep780049 wants to merge 1 commit into
Conversation
|
This pull request did not pass quality checks and AI use is suspected. Please review Contribute and make any necessary amendments. |
|
Profile summary: Full profile |
Documentation build overview
8 files changed ·
|
…Todo Fixes parts of #1473: Availability.new no longer describes itself as an event, previously undocumented parameters are now documented, Available.new documents its required start, and Alarm.new points to the action-specific constructors. Adds a news fragment. Responsible AI use: Claude was used to audit the docstrings against RFC 5545 and RFC 7953 and draft the wording. The final change was manually verified.
4b6d3e1 to
a079d2b
Compare
|
Responding to the quality check: I have rewritten this pull request description using the repository's pull request template with the required sections, kept it within the length limit, and added the Responsible AI use disclosure to the commit message as required by the contribute guide. The AI use was limited to auditing the docstrings against the RFCs and drafting wording, and every change was manually verified against the implementation and the test suite. |
|
This pull request did not pass quality checks and AI use is suspected. Please review Contribute and make any necessary amendments. |
|
This pull request did not pass quality checks and AI use is suspected. Please review Contribute and make any necessary amendments. |
|
This pull request did not pass quality checks and AI use is suspected. Please review Contribute and make any necessary amendments. |
|
This pull request did not pass quality checks and AI use is suspected. Please review Contribute and make any necessary amendments. |
|
Withdrawing this contribution for now. Thank you for the work you put into reviewing and maintaining icalendar. |
|
@sandeep780049 please ignore the bot notice. See #1753. Looking at the summary from the bot, its notification is a false positive. I think your contribution has merit. Would you please consider reopening your PR? |
|
Reopening wasn't possible (GitHub blocks it once the head fork is deleted), so I've opened #1805 with the exact same commits. Sorry again for the confusion about the bot notice. |
Linked issue
newclass methods #1473Description
Audited the constructor docstrings of the unchecked components against the implementation and the applicable RFCs, and corrected the inaccuracies found: a wrong component type in one, three missing parameters, one required argument now documented as required, and one overstated claim removed. One file verified accurate and unchanged. Change log fragment included; Responsible AI use disclosed in the commit message.
Checklist