Skip to content

docs: correct vUnknown xCal parameter documentation - #2151

Open
sshnox wants to merge 2 commits into
PyCalendar:mainfrom
sshnox:docs/1072-vunknown-xcal-parameters
Open

sshnox wants to merge 2 commits into
PyCalendar:mainfrom
sshnox:docs/1072-vunknown-xcal-parameters

Conversation

@sshnox

@sshnox sshnox commented Nov 18, 2026 •

Copy link
Copy Markdown

Linked issue

Contributes to #1072.

Description

Summary

Corrects two vUnknown xCal method docstrings to document their actual parser and params arguments, return values, and exception references.

Changes

  • Corrected Google-style parameter documentation in two methods.
  • Added changelog entry news/1072.documentation.5.
  • No runtime behavior was changed.

Testing

  • Verified both modified files are committed on the source branch.
  • Full upstream tests and documentation CI have not yet been run.

AI disclosure

OpenAI GPT-6 assisted in inspecting the method signatures, drafting the documentation corrections, and preparing the changelog entry. AI use is also disclosed in commit messages.

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.

Additional information

  • Verified both modified files are committed on the source branch.
  • Full upstream tests and documentation CI have not yet been run.

Contributes to PyCalendar#1072.

AI assistance: OpenAI GPT-6 inspected the two vUnknown xCal
classmethod signatures and generated corrected Google-style
Parameters, Returns, and exception references; the changes are
limited to these two docstrings. Prompt summarized: identify stale
parameter names and align docs to method signatures.
Contributes to PyCalendar#1072. AI: OpenAI GPT-6 drafted the changelog
entry and AI usage disclosure using the updated vUnknown docs and
icalendar's contribution requirements.
@github-actions

Copy link
Copy Markdown
Contributor

Thanks for the pull request, @sshnox! A maintainer will review it shortly.

@github-actions

Copy link
Copy Markdown
Contributor

Automation signals

Activity patterns show signs of automation.

View full analysis →

Report this account →

Evidence
  • Fork spike detected: Burst of 11 fork events in a single 24-hour window

This is an automated analysis by AgentScan

@github-actions github-actions Bot added the agentscan:automated-account AgentScan flagged this item as coming from an automated account, and it needs review label Nov 18, 2026
@sshnox
sshnox marked this pull request as ready for review November 18, 2026 12:51
@stevepiercy

Copy link
Copy Markdown
Member

Possible duplicate of #2132. @sshnox would you please review that PR, make suggestions to improve it, and if you PR is a duplicate then close this one. Thank you!

This branch has not been deployed

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

Labels

agentscan:automated-account AgentScan flagged this item as coming from an automated account, and it needs review PR quality: good

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants