mh/convert doc to gapdoc - #11
Open
fingolfin wants to merge 2 commits into
Open
Conversation
fingolfin
commented
Aug 20, 2026
fingolfin
commented
Member
- Convert documentation to GAPDoc/AutoDoc
- Fix minor errors in the manual
The committed tst/manual.example-*.tst go too: they were extracted from the manual by the old build, but had not been regenerated since, and one of them still tested a command the manual no longer contains. AutoDoc extracts the examples into tst/format0*.tst on every build instead. The examples had drifted -- generator orderings, a ViewObj change and a KnownAttributesOfObject list that GAP has since altered -- and are now what GAP actually prints. Note that the package defines \F and \X as calligraphic letters for a formation and a class of groups, which the converter would otherwise read as the blackboard-bold field.
Three names in the manual do not exist in the package: FCoveringGroup1 and FormationCoveringGroup, where CoveringSubgroupWrtFormation in fact falls back to CoveringSubgroup1, and FScreen for the record component fScreen. Also \|G\| is the double bar, where the order of G is meant.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #11 +/- ##
=======================================
Coverage 60.60% 60.60%
=======================================
Files 7 7
Lines 1226 1226
=======================================
Hits 743 743
Misses 483 483 🚀 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.