Repository navigation
Move queue chapter intro to the start of its chapter - #162
Merged
Merged
Conversation
doc/Intros.autodoc creates the chapter "Queues and Deques", and gap/plistdeque.gd is read before gap/queue.gd and adds a section to it. The chapter introduction in gap/queue.gd therefore ended up at the end of that section. Moving it to doc/Intros.autodoc puts it before the first section, and avoids a warning from upcoming AutoDoc versions. Assisted-by: Generative AI
fingolfin
force-pushed
the
mh-ai/autodoc-intro-placement
branch
from
November 10, 2026 21:30
2863fb8 to
f5ae2dc
Compare
fingolfin
commented
Nov 10, 2026
| #! The API that objects that lie in <Ref Filt="IsQueue" Label="for IsObject"/> and | ||
| #! <Ref Filt="IsDeque" Label="for IsObject"/> must implement the API set out below. | ||
| #! | ||
| #! <Package>datastructures</Package> provides |
Member
Author
There was a problem hiding this comment.
I've deleted this incomplete sentence
fingolfin
enabled auto-merge (squash)
November 10, 2026 21:30
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #162 +/- ##
==========================================
- Coverage 95.32% 95.32% -0.01%
==========================================
Files 35 35
Lines 2673 2671 -2
Branches 110 110
==========================================
- Hits 2548 2546 -2
Misses 105 105
Partials 20 20
🚀 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.
Upcoming AutoDoc versions (gap-packages/AutoDoc#390) warn about plain text that AutoDoc discards, or that the manual shows inside a preceding section because it is added to the chapter after that section. Here, the introduction of the chapter "Queues and Deques" in gap/queue.gd ended up at the end of section "Deques implemented using plain lists", because gap/plistdeque.gd is read first. Moving it to doc/Intros.autodoc puts it at the start of the chapter.
AI disclosure: prepared with Claude Code, which found the cause, wrote the change, and checked that the manual builds without warnings.
🤖 Generated with Claude Code