Skip to content

docs: fix unqualified class references in enums.py#1388

Open
Godzilaa wants to merge 1 commit into
collective:mainfrom
Godzilaa:fix/broken-class-refs-enums
Open

docs: fix unqualified class references in enums.py#1388
Godzilaa wants to merge 1 commit into
collective:mainfrom
Godzilaa:fix/broken-class-refs-enums

Conversation

@Godzilaa
Copy link
Copy Markdown

@Godzilaa Godzilaa commented May 14, 2026 •
edited by github-actions Bot
Loading

Fix unqualified :class:FBTYPE and `:class:`BUSYTYPE references
in enums.py docstrings by adding fully qualified paths so Sphinx
can resolve the links correctly.

Contributes to #1158

📚 Documentation preview 📚: https://icalendar--1388.org.readthedocs.build/

@read-the-docs-community
Copy link
Copy Markdown

read-the-docs-community Bot commented May 14, 2026 •
edited
Loading

Documentation build overview

📚 icalendar | 🛠️ Build #32723606 | 📁 Comparing 51913e6 against latest (66fb3e1)

  🔍 Preview build  

7 files changed · ± 7 modified

± Modified

@coveralls
Copy link
Copy Markdown

coveralls commented May 17, 2026

Coverage Report for CI Build 25986706211

Coverage remained the same at 97.775%

Details

  • Coverage remained the same as the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.

Coverage Stats

Coverage Status
Relevant Lines: 12624
Covered Lines: 12348
Line Coverage: 97.81%
Relevant Branches: 770
Covered Branches: 748
Branch Coverage: 97.14%
Branches in Coverage %: Yes
Coverage Strength: 2.93 hits per line
💛 - Coveralls

@stevepiercy
Copy link
Copy Markdown
Member

stevepiercy commented May 21, 2026 •
edited
Loading

@Godzilaa would you please add a change log entry, per https://icalendar.readthedocs.io/en/stable/contribute/index.html#change-log-entry-format and address the failing CI check? See https://icalendar.readthedocs.io/en/stable/contribute/development.html#format-code. Also would you please update your branch agains main?

@stevepiercy
Copy link
Copy Markdown
Member

stevepiercy commented May 21, 2026

@Godzilaa this PR includes changes from another PR. I can't review this in its current state. Please update this branch against main to remove unrelated changes. Thank you!

@Godzilaa
docs: fix unqualified class references in enums.py
7702da0 
Fully qualify :class:`FBTYPE` and :class:`BUSYTYPE` references
in docstrings so Sphinx can resolve the links correctly.

Contributes to collective#1158

Used AI model: opencode/deepseek-v4-flash-free
Used for: generating the fix for fully qualified class references,
adding the changelog entry, and fixing line length formatting.
@Godzilaa Godzilaa force-pushed the fix/broken-class-refs-enums branch from 51913e6 to 7702da0 Compare May 21, 2026 11:07
@Godzilaa
Copy link
Copy Markdown
Author

Godzilaa commented May 21, 2026

I've updated the branch against main to remove the unrelated timezone.py changes. The PR now only contains the enums.py fix plus the required changelog entry. Ruff checks are passing and all tests succeed.

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

Reviewers

@niccokunzmann niccokunzmann Awaiting requested review from niccokunzmann niccokunzmann is a code owner

@SashankBhamidi SashankBhamidi Awaiting requested review from SashankBhamidi SashankBhamidi is a code owner

@stevepiercy stevepiercy Awaiting requested review from stevepiercy stevepiercy is a code owner

@angatha angatha Awaiting requested review from angatha angatha is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Godzilaa @coveralls @stevepiercy