Repository navigation
Split AutoDoc() option docs into subsections - #389
Merged
Merged
Conversation
The options record of AutoDoc() was documented as one list nested up to four levels deep, which was hard to read and offered no anchors for linking to individual options. Each group of options now gets its own subsection after the AutoDoc() ManSection, which keeps a short overview with cross references. Also drop the documentation of autodoc.level, which has had no effect since the leveling code was removed, and consistently use the name optrec instead of opt. Fixes #381 Assisted-by: Generative AI
fingolfin
changed the title
fingolfin
force-pushed
the
mh-ai/autodoc-optrec-docs
branch
from
November 10, 2026 17:15
5ef2669 to
302b5be
Compare
fingolfin
enabled auto-merge (squash)
November 10, 2026 17:16
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #389 +/- ##
=======================================
Coverage 93.00% 93.00%
=======================================
Files 15 15
Lines 3144 3144
=======================================
Hits 2924 2924
Misses 220 220
🚀 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.
The options record of AutoDoc() was documented as one list nested up
to four levels deep, which was hard to read and offered no anchors
for linking to individual options. Each group of options now gets its
own subsection after the AutoDoc() ManSection, which keeps a short
overview with cross references.
Also drop the documentation of autodoc.level, which has had no effect
since the leveling code was removed, and consistently use the name
optrec instead of opt.
Fixes #381
Assisted-by: Generative AI