Skip to content

docs(api): drop the "Bases: object" line from every class page - #583

Merged
breimanntools merged 1 commit into
masterfrom
doc/api-page-polish
Sep 18, 2026
Merged

breimanntools merged 1 commit into
masterfrom
doc/api-page-polish

Conversation

@breimanntools

Copy link
Copy Markdown
Owner

Every public class derives from object or from an internal template ABC, so the Bases: object line on each API page carries no information and pushes the class summary down.

The cause was not what it looked like

docs/source/conf.py contained "show-inheritance": False in autodoc_default_options. That reads as a switch that turns the feature off, and it turns it on: autodoc enables a flag option when the key is present, whatever the value.

Removing the :show-inheritance: line from the autosummary class template alone changed nothing — a full rebuild still showed the line on all 43 class pages, which is how the real cause surfaced. Both are gone now, and conf.py carries a NOTE so the key is not "restored" to False by someone reading it the obvious way.

Verification

Full build, both before and after:

pages with Bases:
before 43 of 43 class pages
after 0 of 233 generated pages

Docs configuration only: no library code, no docstring touched.

🤖 Generated with Claude Code

Every public class derives from `object` or from an internal template ABC,
so the line carries no information and pushes the class summary down.

The cause was not what it looked like. conf.py contained
`"show-inheritance": False` in autodoc_default_options, which reads as a
switch that turns the feature OFF and in fact turns it ON: autodoc enables
a flag option when the KEY IS PRESENT, whatever the value. Removing the
`:show-inheritance:` line from the autosummary class template alone
changed nothing - a rebuild still showed the line on all 43 class pages,
which is how the real cause surfaced. Both are now gone, and conf.py
carries a NOTE so the key is not "restored" to False later.

Verified on a full build: 0 of 233 generated pages contain "Bases:",
where 43 of 43 class pages did before.

Docs configuration only; no library code and no docstring touched.

Co-Authored-By: Claude Fable 5.1 <[email protected]>
@codecov

codecov Bot commented Sep 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.39%. Comparing base (3c11c90) to head (ef51829).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #583   +/-   ##
=======================================
  Coverage   95.39%   95.39%           
=======================================
  Files         222      222           
  Lines       23387    23387           
  Branches     4073     4073           
=======================================
  Hits        22309    22309           
  Misses        631      631           
  Partials      447      447           
Components Coverage Δ
cpp_core 95.97% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@breimanntools
breimanntools merged commit 8888447 into master Sep 18, 2026
22 checks passed
@breimanntools
breimanntools deleted the doc/api-page-polish branch September 18, 2026 21:04
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.

1 participant