Docstring url property 1244#1425
Merged
stevepiercy merged 6 commits intoJun 3, 2026
Merged
Conversation
- Rename news file to 1244.documentation.1 to avoid conflict - Add 'Examples:' section heading - Increase indentation of example code blocks (4 spaces) - Ensure proper rendering in documentation
samrodri911
requested review from
SashankBhamidi,
angatha,
niccokunzmann and
stevepiercy
as code owners
samrodri911
force-pushed
the
docstring-url-property-1244
branch
from
8718a90 to
63f859f
Compare
AI Disclosure: - Model used: Gemini - Interaction: Assisted in locating and resolving the F822 undefined name error in the __all__ list.
samrodri911
force-pushed
the
docstring-url-property-1244
branch
from
0b66885 to
54394c6
Compare
Documentation build overview
15 files changed ·
|
Member
|
Supersedes #1418. |
stevepiercy
requested changes
May 31, 2026
Member
stevepiercy
left a comment
stevepiercy
left a comment
There was a problem hiding this comment.
This is almost done. Thanks for your patience. There's just one correction to make, and verify that it renders correctly.
To review:
- https://icalendar--1425.org.readthedocs.build/en/1425/reference/api/icalendar.cal.availability.html#icalendar.cal.availability.Availability.url
- https://icalendar--1425.org.readthedocs.build/en/1425/reference/api/icalendar.cal.calendar.html#icalendar.cal.calendar.Calendar.url
- https://icalendar--1425.org.readthedocs.build/en/1425/reference/api/icalendar.cal.event.html#icalendar.cal.event.Event.url
- https://icalendar--1425.org.readthedocs.build/en/1425/reference/api/icalendar.cal.free_busy.html#icalendar.cal.free_busy.FreeBusy.url
- https://icalendar--1425.org.readthedocs.build/en/1425/reference/api/icalendar.cal.journal.html#icalendar.cal.journal.Journal.url
- https://icalendar--1425.org.readthedocs.build/en/1425/reference/api/icalendar.cal.todo.html#icalendar.cal.todo.Todo.url
Co-authored-by: Steve Piercy <web@stevepiercy.com>
stevepiercy
approved these changes
Jun 3, 2026
Member
stevepiercy
left a comment
stevepiercy
left a comment
There was a problem hiding this comment.
Thank you for your perseverance and patience to improve icalendar. This is good to merge, after CI passes.
Coverage Report for CI Build 26886893278Warning Build has drifted: This PR's base is out of sync with its target branch, so coverage data may include unrelated changes. Coverage remained the same at 97.836%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsNo coverage regressions found. Coverage Stats
💛 - Coveralls |
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
4 participants
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.
I've resolved the lingering issues raised by @stevepiercy:
Fixed news file conflict: Renamed
news/1244.documentationtonews/1244.documentation.1to avoid conflict with the previously merged PR that used the same filename.Added Examples section heading: Added a proper "Examples:" section heading to organize the code examples better.
Fixed indentation: Increased the indentation of all example code blocks by 4 spaces to ensure proper rendering in the documentation preview.
The changes are now ready for review. The documentation should display correctly as shown in the ReadTheDocs preview.
📚 Documentation preview 📚: https://icalendar--1425.org.readthedocs.build/en/1425/