docs: clarify Journal.new() and Available.new() docstrings - #1507
Closed
checkzhao8888 wants to merge 1 commit into
Closed
docs: clarify Journal.new() and Available.new() docstrings#1507checkzhao8888 wants to merge 1 commit into
checkzhao8888 wants to merge 1 commit into
Conversation
Mark optional parameters explicitly, document auto-generated UID and DTSTAMP values, and remove a nonexistent end parameter from Journal.new(). See collective#1473 AI: Grok — reviewed Journal.new() and Available.new() against prior collective#1473 docstring updates; drafted the docstring wording.
checkzhao8888
requested review from
SashankBhamidi,
angatha,
niccokunzmann and
stevepiercy
as code owners
June 25, 2026 06:38
Contributor
|
Profile summary: Full profile |
Member
|
Complete one PR. Then open the next one when you have engaged in feedback. Closing this as spam for now. |
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
Journal.new()andAvailable.new()docstrings to align with RFC terminology and match the style used in othernew()docstring updates (for example, #1504–#1506).Changes:
UIDandDTSTAMPvalues when arguments areNone.endparameter from theJournal.new()docstring.AI disclosure: Grok assisted with reviewing the implementations, comparing existing
new()docstring patterns, and drafting the updates.Checklist
/news, following the instructions in Change log entry format.