Merge README into README.md and the manual - #70
Merged
Conversation
The old `README` file, written by the original authors, largely duplicated or predated the package manual. Its description of how the library is organised -- layers, file layout, storage formats and identification algorithms -- is now a chapter of the manual, with the references turned into proper citations. The introduction moved into `README.md`; the function list was dropped (the manual documents these functions), as were the authors' postal addresses and the request to report bugs by e-mail. Resolves #35 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
SglPPow extends this library with the groups of order p^7 for p > 11 and those of order 3^8, and after loading it these are reachable through `SmallGroup` and friends. SOTGrps covers the orders factorising into at most four primes and those of the form p^4*q, but with its own functions and its own numbering, which is worth warning about. This only addresses the documentation half of issue #22; whether to also emit info messages remains open. 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 #70 +/- ##
=======================================
Coverage 99.84% 99.84%
=======================================
Files 493 493
Lines 327377 327377
=======================================
Hits 326861 326861
Misses 516 516 🚀 New features to boost your workflow:
|
Chapter 2 now lists which orders each layer holds, so the abridged copy in the overview can just link there. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Spell out "at most NNN" instead of "<= NNN" for the order bounds, as the old overview list did. Drop the paragraph on how much space the data occupies -- those figures predate the compression in 1.5.1 and nobody cares nowadays anyway -- along with the link to the authors' Small Groups page: its "selected publications" are all cited here already. Co-Authored-By: Claude Opus 5 <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
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.
The old
READMEfile, written by the original authors, sat next toREADME.mdwith no clear division of labour: parts of it duplicated themanual, parts predated it, and parts had gone stale. This merges it away, so
that
README.mdis the only README.Merge
READMEintoREADME.mdand the manualIts description of how the library is organised — the layers, their file
layout, the storage formats, and the identification algorithms — becomes a
new manual chapter, The Organisation of the Small Groups Library. The
[1]…[17]reference list turned into proper citations; most bibliographykeys already existed, and I added four (Hölder 1893 and 1895, Bagnera 1898,
James–Newman–O'Brien 1990). GrpConst and ANUPQ are now named as packages
rather than cited.
Two things were repaired along the way. The "Files and Directories" section
still described the old
smalldirectory of the GAP distribution, withreadsml.gandsmall.giat top level; it now matches the actual packagelayout. And
doc/overview.xmlpointed readers at "an extensiveREADMEfile … in the
smalldirectory of the GAP distribution", which now pointsat the new chapter instead.
The introduction moved into
README.md, with the list of available ordersrefreshed to match the manual's rather than the 2008 one. Dropped entirely:
the authors' postal addresses, the "Available functions" list (the manual
documents these, and the copy in
READMEwas missing everything added since2008), and the request to report bugs by e-mail —
README.mdalready pointsat the issue tracker.
Mention SglPPow and SOTGrps
A "Related packages" section in both the manual and
README.mdmentionsSglPPow (p^7 for p > 11, and 3^8; it extends this library, so its groups
arrive through
SmallGroupand friends) and SOTGrps (orders factorisinginto at most four primes, and p^4·q; its own functions, and its own
numbering, which differs from ours where the ranges overlap).
That covers the documentation half of #22 only — whether to also emit info
messages is still open there.
Don't duplicate the list of layers
The overview carried an abridged copy of the layer list. Now that the new
chapter says which orders each layer holds, the overview just links there.
Polish
The order bounds are spelled out as "at most 1000" rather than "<= 1000", as
the overview list used to do. And the paragraph claiming the data occupies
about 30 MB and the identification about 47 MB is gone: those figures
predate the compression in 1.5.1, and nobody counts megabytes for this
nowadays. It took the link to http://www.icm.tu-bs.de/ag_algebra/software/small/
with it — that page is still live, but its six "selected publications" are
all cited a couple of sentences further down anyway.
Resolves #35
🤖 Generated with Claude Code