docs: clarify standalone autodoc files#331
Merged
Conversation
Expand the manual's plain-text file coverage so it explains what .autodoc files are, how AutoDoc finds them, and which commands only make sense in declaration-adjacent source comments. Also add overview and tutorial guidance for choosing between source comments and standalone .autodoc files, and refresh the generated manual expectations. 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 #331 +/- ##
=======================================
Coverage 90.92% 90.92%
=======================================
Files 13 13
Lines 2523 2523
=======================================
Hits 2294 2294
Misses 229 229 🚀 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.
Expand the manual's plain-text file coverage so it explains what
.autodoc files are, how AutoDoc finds them, and which commands
only make sense in declaration-adjacent source comments.
Also add overview and tutorial guidance for choosing between
source comments and standalone .autodoc files, and refresh the
generated manual expectations.
Co-authored-by: Codex codex@openai.com