docs: make RSVP parameter docstring static - #1652
Conversation
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
|
This pull request did not pass quality checks and AI use is suspected. Please review Contribute and make any necessary amendments. |
|
Profile summary: Full profile |
stevepiercy
left a comment
There was a problem hiding this comment.
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.
| 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. |
There was a problem hiding this comment.
Does this turn up in the docs?
There was a problem hiding this comment.
Yes, it was moved, which you can see in the diff feature of RTD, as mentioned in my comment above.
|
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? |
Linked issue
Description
Move the
RSVPparameter documentation from the generated property helper to a static attribute docstring. This removes the documentation argument fromboolean_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/RSVPslice. It does not overlap #1651, which handlesquoted_list_parameterand its callers.Checklist
Additional information
Validation completed locally:
RSVPdocumentationThe 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.