Conversation
Clarify in both the tutorial and reference manual that autodoc.scan_dirs controls scanning for AutoDoc source comments and .autodoc files, while gapdoc.scan_dirs only controls scanning for GAPDoc comments. This also corrects the tutorial examples to use the autodoc record for the documented behavior. Fixes #263 AI assistance was provided by Codex for reviewing the existing documentation, drafting the wording changes, and updating the generated manual fixtures. Co-authored-by: Codex <codex@openai.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #345 +/- ##
=======================================
Coverage 91.64% 91.65%
=======================================
Files 13 13
Lines 2597 2600 +3
=======================================
+ Hits 2380 2383 +3
Misses 217 217
🚀 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
1 participant
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.
Clarify in both the tutorial and reference manual that
autodoc.scan_dirs controls scanning for AutoDoc source comments
and .autodoc files, while gapdoc.scan_dirs only controls scanning
for GAPDoc comments. This also corrects the tutorial examples to
use the autodoc record for the documented behavior.
Fixes #263
AI assistance was provided by Codex for reviewing the existing
documentation, drafting the wording changes, and updating the
generated manual fixtures.
Co-authored-by: Codex codex@openai.com