Skip to content

docs: clarify new() docstrings of Alarm, Availability, Available and Todo - #1800

Closed
sandeep780049 wants to merge 1 commit into
PyCalendar:mainfrom
sandeep780049:docstring-new-1473
Closed

sandeep780049 wants to merge 1 commit into
PyCalendar:mainfrom
sandeep780049:docstring-new-1473

Conversation

@sandeep780049

@sandeep780049 sandeep780049 commented Sep 16, 2026 •

Copy link
Copy Markdown
Contributor

Linked issue

Description

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

  • I added a change log entry, following the instructions in all subsections under Change log requirements.
  • I followed icalendar's Artificial intelligence policy and disclosed my Responsible AI use in my commit messages, if applicable.
  • I added or updated tests, if applicable.
  • I ran and ensured all tests pass locally by following Run tests.
  • I added or edited documentation as necessary, both as docstrings to be rendered in the API documentation and narrative documentation, following the Style guide.

@github-actions github-actions Bot added the ai-suspicion This contribution is possibly created with lots of AI help without enough human understanding. label Sep 16, 2026
@github-actions

Copy link
Copy Markdown
Contributor

This pull request did not pass quality checks and AI use is suspected. Please review Contribute and make any necessary amendments.

@github-actions

Copy link
Copy Markdown
Contributor

Profile summary:

GitHub user: sandeep780049
🟡 Some concerns found with user's profile.
🟢 No concerns found with recent PR activity.
🟢 No concerns found with recent issue activity.

For a more detailed report, run `gh-profiler sandeep780049`.
Full profile
GitHub user: sandeep780049
🟡 Some concerns found with user's profile.
   🟢 Account age: 1 year, 1 month
   🟡 Profile information:
        name: Sandeep yadav
      Empty fields: company, blog, location, email, bio

🟢 No concerns found with recent PR activity.
   10 PRs opened in the last 21 days.
      0 opened against repos the user owns.
      0 opened against repos in publicly associated orgs.
      10 opened against external repos.

   🟢 0 of 10 external PRs closed without merging in the last 21 days.

🟢 No concerns found with recent issue activity.
   1 new issues opened in the last 21 days.
      0 opened in repos the user owns.
      0 opened in repos in publicly associated orgs.
      1 opened in external repos.

   🟢 0 external issues closed as NOT_PLANNED.
   🟢 0 external issues opened with the same title.

@read-the-docs-community

read-the-docs-community Bot commented Sep 16, 2026 •

Copy link
Copy Markdown

@coveralls-official

coveralls-official Bot commented Sep 16, 2026 •

Copy link
Copy Markdown

Coverage Status

coverage: 97.752%. remained the same — sandeep780049:docstring-new-1473 into collective:main

…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.
@sandeep780049

Copy link
Copy Markdown
Contributor Author

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.

@github-actions

Copy link
Copy Markdown
Contributor

This pull request did not pass quality checks and AI use is suspected. Please review Contribute and make any necessary amendments.

@github-actions

Copy link
Copy Markdown
Contributor

This pull request did not pass quality checks and AI use is suspected. Please review Contribute and make any necessary amendments.

@github-actions

Copy link
Copy Markdown
Contributor

This pull request did not pass quality checks and AI use is suspected. Please review Contribute and make any necessary amendments.

@github-actions

Copy link
Copy Markdown
Contributor

This pull request did not pass quality checks and AI use is suspected. Please review Contribute and make any necessary amendments.

@sandeep780049

Copy link
Copy Markdown
Contributor Author

Withdrawing this contribution for now. Thank you for the work you put into reviewing and maintaining icalendar.

@stevepiercy

Copy link
Copy Markdown
Member

@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?

@sandeep780049

Copy link
Copy Markdown
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-suspicion This contribution is possibly created with lots of AI help without enough human understanding.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants