Repository navigation
Fix typos, grammar and four incorrect statements in the documentation - #13
Merged
Merged
Conversation
Correct misspellings, grammar slips and a few markup problems in the manual, the README and the package abstract. Blank lines between paragraphs in the manual become <P/>, since GAPDoc otherwise runs the paragraphs together. No line is added or removed in manual.xml, so the line references in the generated test files stay valid. Assisted-by: Claude Code (Opus 5.5)
- SubalgebraOfClosedSet was documented as LieAlgebraOfClosedSet, a name that does not exist; the example already used the real one. - RandomSL2Triple returns a triple (y,h,x) like SL2Triple, not (x,h,y). - RegularSemisimpleSubalgebras returns the regular semisimple subalgebras only. - In the three-argument CharacteristicsOfStrata the basis is completed by the centre of L; the centre of its derived subalgebra K is zero. Assisted-by: Claude Code (Opus 5.5)
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #13 +/- ##
=======================================
Coverage 97.15% 97.15%
=======================================
Files 16 16
Lines 92584 92584
=======================================
Hits 89950 89950
Misses 2634 2634 🚀 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.
A read through the manual, the README and
PackageInfo.g, in two commits.The first commit fixes about 55 misspellings, grammar slips and markup problems in the manual, two in the README, and the package abstract, which ended in a comma. It also turns 19 blank lines between paragraphs of the manual into
<P/>; GAPDoc otherwise runs those paragraphs together.The second commit changes what the manual claims in four places:
SubalgebraOfClosedSetwas documented under the nameLieAlgebraOfClosedSet, which does not exist in the package. The example already used the real name.RandomSL2Triplewas said to return(x,h,y). The code returns(y,h,x), likeSL2Triple.RegularSemisimpleSubalgebraswas described as returning all semisimple subalgebras. It now says "regular" and "representatives of".CharacteristicsOfStrata, the basis was said to be completed byLieCentre(K), whereKis the derived subalgebra and so has zero centre. The code and the example useLieCentre(L).AI disclosure: Claude Code (Opus 5.5) read the documentation, made these changes and wrote this description.