Skip to content

docs: clarify Event.new() optional and auto-generated properties - #1504

Merged
SashankBhamidi merged 5 commits into
collective:mainfrom
checkzhao8888:docs/clarify-event-new-docstring
Aug 8, 2026
Merged

docs: clarify Event.new() optional and auto-generated properties#1504
SashankBhamidi merged 5 commits into
collective:mainfrom
checkzhao8888:docs/clarify-event-new-docstring

Conversation

@checkzhao8888

Copy link
Copy Markdown

Linked issue

Description

Clarifies the Event.new() docstring to align with RFC terminology used elsewhere in the project (for example, #1459 for Calendar.new()).

Changes:

  • Replace the misleading summary "with all required properties" with "Create a new event."
  • Mark optional parameters explicitly.
  • Document auto-generated UID and DTSTAMP values when arguments are None.

AI disclosure: Grok assisted with reviewing RFC terminology, comparing existing new() docstring patterns, and drafting the update.

Checklist

  • I've added a change log entry to /news, following the instructions in Change log entry format.
  • I've added or updated tests if applicable.
  • I've run and ensured all tests pass locally by following Run tests.
  • I've added or edited documentation, both as docstrings to be rendered in the API documentation and narrative documentation, as necessary.

@github-actions

Copy link
Copy Markdown
Contributor

Profile summary:

GitHub user: checkzhao8888
🟢 No 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 checkzhao8888`.
Full profile
GitHub user: checkzhao8888
🟢 No concerns found with user's profile.
   🟢 Account age: 5 months
   🟢 Profile information:
        name: Checkzhao
        blog: aws.checkzhao.com
        location: Singapore
        email: 475152974zhao@gmail.com
        bio:
          Former ops → AI automation solo builder.
          Building http://aws.checkzhao.com in public.
          Codex · Antigravity · GPT · agents · workflows
        twitter: https://x.com/wkngsn72674
      Empty fields: company

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

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

🟢 No concerns found with recent issue activity.
   🟢 No new issues opened in the last 21 days.

@read-the-docs-community

read-the-docs-community Bot commented Jun 25, 2026

Copy link
Copy Markdown

Comment thread src/icalendar/cal/event.py Outdated
@niccokunzmann

Copy link
Copy Markdown
Member

@angatha, I will assign this to you. I cannot wrap my head around wether this is useful. Feel free to call in steve or close it if there is no response.

Comment thread src/icalendar/cal/event.py Outdated

@stevepiercy stevepiercy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the suggested changes, I will approve. Thank you!

Comment thread src/icalendar/cal/event.py Outdated
Comment thread src/icalendar/cal/event.py Outdated
Comment thread src/icalendar/cal/event.py Outdated
checkzz and others added 2 commits August 5, 2026 22:25
Align Event.new() parameter documentation with RFC terminology by
marking optional arguments explicitly and documenting auto-generated
UID and DTSTAMP values.

See collective#1473

AI: Grok — reviewed Event.required, Calendar.new (collective#1459), and Alarm.new
PR patterns; drafted the docstring wording.
@SashankBhamidi
SashankBhamidi force-pushed the docs/clarify-event-new-docstring branch from c5bf064 to b7a26f3 Compare August 5, 2026 16:56
angatha
angatha previously approved these changes Aug 6, 2026
Comment thread news/1473.documentation

@stevepiercy stevepiercy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution. Will auto-merge after CI passes.

@SashankBhamidi
SashankBhamidi merged commit db6898c into collective:main Aug 8, 2026
46 checks passed
@coveralls

Copy link
Copy Markdown
Collaborator

Coverage Status

coverage: 98.085%. remained the same — checkzhao8888:docs/clarify-event-new-docstring into collective:main

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants