Convert documentation to GAPDoc/AutoDoc - #14
Merged
Conversation
Replace the plain-TeX (gapmacro.tex) manual with GAPDoc XML built via AutoDoc, and drop doc/make_doc in favour of a makedoc.g in the package root. See gap-system/gap#639. Converted mechanically with dev/gapmacro2gapdoc.py from the GAP repository. Beyond the markup, three things needed attention, all of them documentation that had gone stale unnoticed: the old build extracted its examples to doc/manual.example-*.tst, which was gitignored and never run. * Chapter "Examples with Runtimes" states that its runtimes come from a 400 Mhz PC, so none of its ten examples can reproduce. They are <Log>, which AutoDoc does not extract, rather than tests that always fail. * The recorded output of several examples predates changes in how GAP prints a pc group -- it now includes the group order -- and the order in which ConstructAllGroups returns groups of order 60 has changed. Refreshed from what GAP actually prints. * One example asked for List(last2, IdGroup) directly after a single command, where the result is last; last2 was something else entirely and the example failed with "no method found". The whole test suite passes, including the package's own tests. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #14 +/- ##
==========================================
+ Coverage 64.08% 70.49% +6.40%
==========================================
Files 12 12
Lines 2169 2169
==========================================
+ Hits 1390 1529 +139
+ Misses 779 640 -139 🚀 New features to boost your workflow:
|
Also drop "share package", GAP 3 terminology, and correct the flag name in the FrattiniExtensionMethod example (nonnilpotent -> nonnilpot).
The order in which CyclicExtensions and UpwardsExtensions return groups depends on the GAP version, so the extracted examples failed on GAP 4.11. Sort the IdGroup lists, select H by isomorphism type instead of position, and drop the printed generating set of H. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Also correct the nonnilpot flag name in the FrattiniExtensionMethod description, which named a non-existent flag. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
Replace the plain-TeX (gapmacro.tex) manual with GAPDoc XML built via
AutoDoc, and drop doc/make_doc in favour of a makedoc.g in the package
root. See gap-system/gap#639.
Converted mechanically with dev/gapmacro2gapdoc.py from the GAP
repository. Beyond the markup, three things needed attention, all of them
documentation that had gone stale unnoticed: the old build extracted its
examples to doc/manual.example-*.tst, which was gitignored and never run.
Chapter "Examples with Runtimes" states that its runtimes come from a
400 Mhz PC, so none of its ten examples can reproduce. They are ,
which AutoDoc does not extract, rather than tests that always fail.
The recorded output of several examples predates changes in how GAP
prints a pc group -- it now includes the group order -- and the order
in which ConstructAllGroups returns groups of order 60 has changed.
Refreshed from what GAP actually prints.
One example asked for List(last2, IdGroup) directly after a single
command, where the result is last; last2 was something else entirely
and the example failed with "no method found".
The whole test suite passes, including the package's own tests.
Co-Authored-By: Claude Opus 5 noreply@anthropic.com