docs: clarify Event.new() optional and auto-generated properties - #1504
Merged
SashankBhamidi merged 5 commits intoAug 8, 2026
Merged
Conversation
checkzhao8888
requested review from
SashankBhamidi,
angatha,
niccokunzmann and
stevepiercy
as code owners
June 25, 2026 06:19
Contributor
|
Profile summary: Full profile |
This was referenced Jun 25, 2026
angatha
requested changes
Jun 26, 2026
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. |
angatha
requested changes
Jul 16, 2026
stevepiercy
requested changes
Jul 16, 2026
stevepiercy
left a comment
Member
There was a problem hiding this comment.
With the suggested changes, I will approve. Thank you!
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
force-pushed
the
docs/clarify-event-new-docstring
branch
from
August 5, 2026 16:56
c5bf064 to
b7a26f3
Compare
angatha
previously approved these changes
Aug 6, 2026
stevepiercy
requested changes
Aug 6, 2026
SashankBhamidi
enabled auto-merge
August 8, 2026 06:28
angatha
approved these changes
Aug 8, 2026
niccokunzmann
approved these changes
Aug 8, 2026
stevepiercy
approved these changes
Aug 8, 2026
stevepiercy
left a comment
Member
There was a problem hiding this comment.
Thank you for your contribution. Will auto-merge after CI passes.
Collaborator
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Linked issue
newclass methods #1473Description
Clarifies the
Event.new()docstring to align with RFC terminology used elsewhere in the project (for example, #1459 forCalendar.new()).Changes:
UIDandDTSTAMPvalues when arguments areNone.AI disclosure: Grok assisted with reviewing RFC terminology, comparing existing
new()docstring patterns, and drafting the update.Checklist
/news, following the instructions in Change log entry format.