Skip to content

Fix typos and wrong literature references - #190

Open
fingolfin wants to merge 2 commits into
mainfrom
mh-ai/fix-typos-and-references
Open

fingolfin wants to merge 2 commits into
mainfrom
mh-ai/fix-typos-and-references

Conversation

@fingolfin

Copy link
Copy Markdown
Member

Correct spelling and grammar in comments, the manual and the README, and fix comments that contradict the code, such as wrong variable names, unbalanced formulas and a wrong field characteristic.

Check every citation of [BHR13], [KL90], [HR05], [HR10] and the other cited papers against the sources and fix those that point to the wrong item: tables of the wrong dimension, class or kind, propositions that are lemmas or theorems, a nonexistent Table 8.86, and a misnumbered page. Rename the bibliography key R-D13 to RD04 to match the year of the paper.

In the manual, list the missing type "S" for ClassicalMaximalsGeneric and separate @arguments with commas, so signatures render as "GLMinusSL( n, q )" instead of "GLMinusSL( n q )". Drop the flat-list mode from the MatrixByEntries documentation, which is not implemented.

Make error messages name the actual arguments and state the condition the code checks, e.g. "at least 3" instead of "at least 2", and update the expected test output.

Assisted-by: Generative AI

@fingolfin

Copy link
Copy Markdown
Member Author

This is fairly big so I'll try to split it up into several PRs that are easier to review (by focusing on one kind of change each)

@codecov

codecov Bot commented Nov 15, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.45%. Comparing base (0c719d7) to head (fce143a).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #190      +/-   ##
==========================================
+ Coverage   98.39%   98.45%   +0.05%     
==========================================
  Files          18       18              
  Lines        8680     8680              
==========================================
+ Hits         8541     8546       +5     
+ Misses        139      134       -5     
Files with missing lines Coverage Δ
gap/AlmostSimpleDefiningCharacteristic.gi 98.94% <ø> (ø)
gap/ClassicalMaximals.gd 100.00% <ø> (ø)
gap/ClassicalMaximals.gi 99.84% <ø> (ø)
gap/ClassicalNormalizerMatrixGroups.gi 93.40% <ø> (ø)
gap/ExtraspecialNormalizerMatrixGroups.gi 97.81% <100.00%> (+0.81%) ⬆️
gap/Forms.gi 95.58% <100.00%> (+0.73%) ⬆️
gap/ImprimitiveMatrixGroups.gi 99.12% <ø> (ø)
gap/ReducibleMatrixGroups.gi 98.76% <100.00%> (ø)
gap/SemilinearMatrixGroups.gi 92.27% <ø> (ø)
gap/SubfieldMatrixGroups.gi 98.46% <100.00%> (ø)
... and 4 more
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@fingolfin
fingolfin force-pushed the mh-ai/fix-typos-and-references branch from 724279f to 6483432 Compare November 15, 2026 00:35
@fingolfin

Copy link
Copy Markdown
Member Author

See PRs #193 and #194 -- once those are in, we can rebase this PR for the rest.

@fingolfin
fingolfin force-pushed the mh-ai/fix-typos-and-references branch from 6483432 to 625bd70 Compare November 15, 2026 09:21
Check every citation of [BHR13], [KL90], [HR05], [HR10] and the other
cited papers against the sources and fix those that point to the wrong
item: tables of the wrong dimension, class or kind, propositions that
are lemmas or theorems, a nonexistent Table 8.86, and a misnumbered
page. Rename the bibliography key R-D13 to RD04 to match the year of
the paper.

Fix comments that contradict the code: wrong variable and function
names, unbalanced or wrong formulas, a wrong field characteristic, and
wrong descriptions of generators.

In the manual, list the missing type "S" for ClassicalMaximalsGeneric
and drop the flat-list mode from the MatrixByEntries documentation,
which is not implemented.

Make error messages name the actual arguments and state the condition
the code checks, e.g. "at least 3" instead of "at least 2", and update
the expected test output.

Assisted-by: Generative AI
@fingolfin
fingolfin force-pushed the mh-ai/fix-typos-and-references branch from 625bd70 to 9912016 Compare November 16, 2026 00:01
Comment thread gap/ClassicalMaximals.gi Outdated
Comment on lines 2515 to 2518
# Cf. Propositions 3.2.5 (n = 3), 3.3.6 (n = 4),
# 3.4.3 (n = 5), 3.6.3 (n = 7),
# 3.7.9 (n = 8), 3.8.5 (n = 9),
# 3.10.3 (n = 11) in [BHR13]

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Cf. Propositions 3.2.5 (n = 3), 3.3.6 (n = 4),
# 3.4.3 (n = 5), 3.6.3 (n = 7),
# 3.7.9 (n = 8), 3.8.5 (n = 9),
# 3.10.3 (n = 11) in [BHR13]
# Cf. Propositions 3.2.5 (n = 3), 3.3.6 (n = 4),
# 3.4.3 (n = 5), 3.6.3 (n = 7),
# 3.7.9 (n = 8), 3.8.5 (n = 9),
# 3.10.3 (n = 11) in [BHR13]

Comment thread gap/SemilinearMatrixGroups.gi Outdated
# the entry M[i, j] is omega ^ k (if M[i, j] = 0 then the corresponding block
# is zero as well).
# This is the function Theta(...) from [HR05] defined on page 61 before Lemma 6.2.
# This is the function Theta(...) from [HR05] defined on page 60 before Lemma 6.2.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least in my copy of [HR05], this is indeed on page 61 (printed page number).

Comment thread gap/Utils.gi Outdated

# If type = "S" then find a beta in GF(q ^ 2) with beta + beta ^ q = alpha.
# If type = "P" then find a beta in GF(q ^ 2) with gamma * gamma ^ q = alpha.
# If type = "P" then find a beta in GF(q ^ 2) with beta * beta ^ q = alpha.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# If type = "P" then find a beta in GF(q ^ 2) with beta * beta ^ q = alpha.
# If type = "P" then find a gamma in GF(q ^ 2) with gamma * gamma ^ q = alpha.

This matches the notation in [HR05].

Restore page 61 for Theta in [HR05], the printed page number, and use
gamma, the notation of [HR05], for the type "P" solution of
SolveFrobeniusEquation. Align the continuation lines of the SU C6
citations.

Test the three error messages this branch reworded and no test
reached.

Assisted-by: Generative AI

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants