docs(boolean): improve vBoolean docstring#1386
Open
tsai135 wants to merge 1 commit into
Open
Conversation
stevepiercy
requested changes
May 21, 2026
Member
stevepiercy
left a comment
There was a problem hiding this comment.
Just a change to the change log, and I'll merge. This is excellent work. Thank you!
| ~~~~~~~~~~~~~ | ||
|
|
||
| - Replace the RFC quotations in the docstrings for :attr:`Alarm.REPEAT <icalendar.cal.alarm.Alarm.REPEAT>` and :attr:`Alarm.DURATION <icalendar.cal.alarm.Alarm.DURATION>` with Pythonic descriptions, including parameter notes, conformance references, and worked examples. :issue:`1244` | ||
| - Replace the RFC quotation in the docstring for :class:`vBoolean <icalendar.prop.boolean.vBoolean>` with a Pythonic description, including parsing behavior, a conformance reference, and a worked example. :issue:`1244` |
Member
There was a problem hiding this comment.
We've changed our change log format in v7.1.1, and now use towncrier to automatically generator the CHANGES.rst file from the change log entries. See https://icalendar.readthedocs.io/en/stable/contribute/index.html#change-log-entry-format.
Would you please revert the change in this file, then add the following content to /news/1244.documentation? Then I'll merge. Thank you!
Suggested change
| - Replace the RFC quotation in the docstring for :class:`vBoolean <icalendar.prop.boolean.vBoolean>` with a Pythonic description, including parsing behavior, a conformance reference, and a worked example. :issue:`1244` | |
| Replaced the RFC quotation in the docstring for :class:`vBoolean <icalendar.prop.boolean.vBoolean>` with a Pythonic description, including parsing behavior, a conformance reference, and a working example. @tsai135 |
Member
There was a problem hiding this comment.
Also, following the new change log process will resolve the merge conflicts, and we'll never have to deal with it again. YAY!
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.
Closes issue
This PR addresses one of the unchecked items in the #1244 checklist:
vBoolean. It does not close the umbrella issue.Description
The existing class docstring for
vBooleancontains RFC-style documentation copied from RFC 5545, including sections such as “Value Name,” “Purpose,” “Format Definition,” and “Description.” The umbrella issue asks for these copied RFC sections to be rewritten as Pythonic docstrings.This PR follows the pattern used in recent #1338 docstring PR:
vBooleandoes in Python terms.vBooleanconverts between Python boolean values and the iCalendarBOOLEANvalue type.TRUEorFALSE, and that values parsed from iCalendar text are case-insensitive.:rfc:directive so Sphinx renders a linked reference instead of copying RFC text.pyconexample showing parsing from iCalendar text and serializing back to iCalendar bytes.The RFC text itself is no longer copied into the class docstring; the
:rfc:link is used as the canonical reference.The
CHANGES.rstentry slots in next to the other:issue:1244 entries under the 7.0.4 Documentation section.Checklist
The doctest suite (
uv run pytest src/icalendar/tests/test_with_doctest.py) passes locally with the new example.Additional information
The other unchecked items under
vBooleanin #1244 are intentionally left for separate PRs to keep this change reviewable.📚 Documentation preview 📚: https://icalendar--1386.org.readthedocs.build/