Skip to content

docs: clarify Todo.new() optional and auto-generated properties - #1506

Closed
checkzhao8888 wants to merge 1 commit into
collective:mainfrom
checkzhao8888:docs/clarify-todo-new-docstring
Closed

docs: clarify Todo.new() optional and auto-generated properties#1506
checkzhao8888 wants to merge 1 commit into
collective:mainfrom
checkzhao8888:docs/clarify-todo-new-docstring

Conversation

@checkzhao8888

Copy link
Copy Markdown

Linked issue

Description

Clarifies the Todo.new() docstring to align with RFC terminology and match the style used in other new() docstring updates (for example, #1504 and #1505).

Changes:

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

AI disclosure: Grok assisted with reviewing the implementation, 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.

Mark optional parameters explicitly, document auto-generated UID and
DTSTAMP values, and document the priority parameter.

See collective#1473

AI: Grok — compared Todo.new() against Event.new() and Availability.new()
docstring updates; drafted the docstring wording.
@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.
   3 PRs opened in the last 21 days.
      0 opened against repos the user owns.
      0 opened against repos in publicly associated orgs.
      3 opened against external repos.

   🟢 0 of 3 external PRs merged in the last 21 days.
   🟢 0 of 3 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

Copy link
Copy Markdown

Documentation build overview

📚 icalendar | 🛠️ Build #33302154 | 📁 Comparing bbacf23 against latest (937f6fc)

  🔍 Preview build  

3 files changed
± 404.html
± reference/api/icalendar.cal.todo.html
± _modules/icalendar/cal/todo.html

@niccokunzmann

Copy link
Copy Markdown
Member

Complete one PR. Then open the next one when you have engaged in feedback. Closing this as spam for now.
Focus on your open PR and do not be proud to think that either the AI or you have understood what the issue is about.

#1504

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.

2 participants