Skip to content

docs: make RSVP parameter docstring static - #1652

Open
floze-the-genius wants to merge 1 commit into
collective:mainfrom
floze-the-genius:docs/1650-static-rsvp-docstring
Open

docs: make RSVP parameter docstring static#1652
floze-the-genius wants to merge 1 commit into
collective:mainfrom
floze-the-genius:docs/1650-static-rsvp-docstring

Conversation

@floze-the-genius

Copy link
Copy Markdown
Contributor

Linked issue

Description

Move the RSVP parameter documentation from the generated property helper to a static attribute docstring. This removes the documentation argument from boolean_parameter, corrects and simplifies the RSVP summary, and leaves its getter, setter, deleter, default, and serialization behavior unchanged.

This PR covers only the boolean_parameter / RSVP slice. It does not overlap #1651, which handles quoted_list_parameter and its callers.

Checklist

  • I added a change log entry, following the instructions in Change log entry format.
  • 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

Validation completed locally:

  • RSVP-focused tests: 47 passed
  • doctests: 374 passed
  • full pytest suite: 17,964 passed, 28 skipped, 541 expected failures
  • Ruff format/check, Towncrier, Vale, and Sphinx HTML with warnings as errors: passed
  • generated API HTML contains the static RSVP documentation

The final external linkcheck still reports existing broken or redirected third-party URLs from files unchanged by this PR. No links are added or modified here.

See collective#1650.

AI-Assisted-By: OpenAI Codex (GPT-5)

AI-Use: Used Codex to inspect issue collective#1650 and the repository contribution policy, draft the focused boolean_parameter and RSVP docstring refactor, and verify it with RSVP tests, doctests, Ruff, Towncrier, the Sphinx documentation build, and the full pytest suite.

AI Prompts:
gpt-5: continue
@github-actions github-actions Bot added the ai-suspicion This contribution is possibly created with lots of AI help without enough human understanding. label Aug 10, 2026
@github-actions

Copy link
Copy Markdown
Contributor

This pull request did not pass quality checks and AI use is suspected. Please review Contribute and make any necessary amendments.

@github-actions

Copy link
Copy Markdown
Contributor

Profile summary:

GitHub user: floze-the-genius
🟢 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 floze-the-genius`.
Full profile
GitHub user: floze-the-genius
🟢 No concerns found with user's profile.
   🟢 Account age: 5 years
   🟢 Profile information:
        name: Floze
        blog: t.me/bastard11
        bio: Open-source systems engineer building coding-agent infrastructure and production platforms. I turn hard failures into durable, upstream-ready fixes
      Empty fields: company, location, email

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

   🟢 2 of 7 external PRs closed without merging in the last 21 days.

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

   🟢 0 external issues closed as NOT_PLANNED.
   🟢 0 external issues opened with the same title.

@read-the-docs-community

Copy link
Copy Markdown

@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.

Thanks for your contribution. I like the docstring narrative improvements. However, after I created the initial issue, I realized that the conversion from generated to static docstrings might not be a good idea for properties. See #1650 (comment) and #1651 (comment). We might move them back. Let's wait for a response from @niccokunzmann on the other PR, and respond accordingly. Also if you have an opinion about which is actually better, I'd appreciate your own thoughts without using AI.

See the diff on RTD.

Comment thread src/icalendar/param.py
Comment thread src/icalendar/param.py
False,
"""Specify whether there is an expectation of a favor of anreply from the calendar user specified by the property value.
RSVP = boolean_parameter("RSVP", False)
"""Indicate whether a reply is expected from the calendar user.

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.

Does this turn up in the docs?

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.

Yes, it was moved, which you can see in the diff feature of RTD, as mentioned in my comment above.

@niccokunzmann

Copy link
Copy Markdown
Member

Hm. I think, this misses the point - the documentation is not in the right place. Could you check the docs and tell my what is happening and why this is a good change?

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

Labels

ai-suspicion This contribution is possibly created with lots of AI help without enough human understanding. doc

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants