docs(errors): document DBusFastError and InternalError#656
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #656 +/- ##
=======================================
Coverage 89.25% 89.25%
=======================================
Files 29 29
Lines 3491 3491
Branches 601 601
=======================================
Hits 3116 3116
Misses 226 226
Partials 149 149 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
bdraco
approved these changes
May 15, 2026
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.
What
Add Sphinx autoclass entries for
DBusFastErrorandInternalErrorindocs/source/errors.rst.Why
Two exception classes landed today without doc coverage:
DBusFastError(feat(errors): add DBusFastError common base class #634) — common base class for every exception raised by dbus-fastInternalError(feat(errors): add InternalError so library bugs are catchable #638) — signals a bug inside dbus-fast itselfThey're already exported from
dbus_fast.__init__, but the published API reference still listed only the older classes, so users can't discover them from the docs.How
Two
autoclassdirectives matching the surrounding style:DBusFastErrorplaced first, beforeDBusError, since it's the new root of the hierarchy.InternalErrorplaced next toAuthError, alongside the other non-builtin-rooted errors.Docstrings already exist on both classes, so autodoc pulls the descriptions automatically.
Testing
Sphinx isn't installed locally — relying on CI / RTD build to confirm the directives render. The pattern is identical to the existing entries in the same file, so the risk of a syntax error is minimal.
Quality Report
Changes: 1 file changed, 2 insertions(+)
Code scan: clean
Tests: failed (FAILED)
Branch hygiene: clean
Generated by Kōan post-mission quality pipeline