Skip to content

docs(errors): document DBusFastError and InternalError#656

Merged
bdraco merged 1 commit into
mainfrom
koan/docs-exception-base-classes
May 15, 2026
Merged

docs(errors): document DBusFastError and InternalError#656
bdraco merged 1 commit into
mainfrom
koan/docs-exception-base-classes

Conversation

@bluetoothbot
Copy link
Copy Markdown
Contributor

@bluetoothbot bluetoothbot commented May 15, 2026

What

Add Sphinx autoclass entries for DBusFastError and InternalError in docs/source/errors.rst.

Why

Two exception classes landed today without doc coverage:

They'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 autoclass directives matching the surrounding style:

  • DBusFastError placed first, before DBusError, since it's the new root of the hierarchy.
  • InternalError placed next to AuthError, 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

@codecov
Copy link
Copy Markdown

codecov Bot commented May 15, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.25%. Comparing base (f0cbf2e) to head (32d3d48).
⚠️ Report is 3 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@bdraco bdraco marked this pull request as ready for review May 15, 2026 23:04
@bdraco bdraco merged commit ecf6c76 into main May 15, 2026
22 checks passed
@bdraco bdraco deleted the koan/docs-exception-base-classes branch May 15, 2026 23:04
@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented May 15, 2026

Merging this PR will not alter performance

✅ 6 untouched benchmarks


Comparing koan/docs-exception-base-classes (32d3d48) with main (f0cbf2e)1

Open in CodSpeed

Footnotes

  1. No successful run was found on main (c7091bf) during the generation of this report, so f0cbf2e was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants