Repository navigation
parser: Warn about misplaced plain text - #390
Merged
Merged
Conversation
Plain text read while no chapter is active was dropped silently. Text added to a chapter after one of its sections, or to a section after one of its subsections, is placed after that child, so GAPDoc renders it as part of the last section or subsection. Both now print a warning with the source position. The commands @chapter, @appendix, @section and @subsection move to a new section "Structuring the documentation" at the start of the comments chapter, which also explains where plain text ends up. Fixes #383 Assisted-by: Generative AI
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #390 +/- ##
==========================================
+ Coverage 93.00% 93.11% +0.10%
==========================================
Files 15 15
Lines 3144 3179 +35
==========================================
+ Hits 2924 2960 +36
+ Misses 220 219 -1
🚀 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.
Plain text read while no chapter is active was dropped silently. Text
added to a chapter after one of its sections, or to a section after
one of its subsections, is placed after that child, so GAPDoc renders
it as part of the last section or subsection. Both now print a
warning with the source position.
The commands @chapter, @appendix, @section and @subsection move to a
new section "Structuring the documentation" at the start of the
comments chapter, which also explains where plain text ends up.
Fixes #383
Assisted-by: Generative AI