docs(api): drop the "Bases: object" line from every class page - #583
Merged
Merged
Conversation
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 Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ 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
🚀 New features to boost your workflow:
|
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.
Every public class derives from
objector from an internal template ABC, so theBases: objectline on each API page carries no information and pushes the class summary down.The cause was not what it looked like
docs/source/conf.pycontained"show-inheritance": Falseinautodoc_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, andconf.pycarries aNOTEso the key is not "restored" toFalseby someone reading it the obvious way.Verification
Full build, both before and after:
Bases:Docs configuration only: no library code, no docstring touched.
🤖 Generated with Claude Code