cpmech/gosl v1.2.15

v1.2.15 — English corrections in comments, docs and messages (no code changes)

on GitHub

Documentation only: no exported API, behavior or dependency changed since v1.2.14 — every changed line of Go differs only inside a comment or a string literal (233 changed line pairs checked, none touched code). Take it if you read the source or the panic messages; for behavior, v1.2.14 is identical.

Status

Gosl is mature and in maintenance mode. It is stable and is used in published work, but new
development has moved to Russell, its successor — if you are
starting a new project, look there first. Reports about Gosl's existing functionality are welcome;
new features are unlikely.

What changed

109 files, 260 lines — all of it prose: Go comments, doc comments, package READMEs, and the wording of user-facing panic and print messages.

• British spellings in prose corrected to American: factorisation/finalisation, licence, colours, centre, analyse, minimise, normalisation, organised, grey, Afterwards. The word "Towards" inside the cited Triangle paper title is left as published.
• Typos: nummber, separeted, tranpose, interger, Ouptut, intepolatory, orthognal, mirrowed, shufled, intices, equalt-to, witten, colocation, upperbound, bissection, standrad, setps, direnction, dependendt, varible, afer, alow, insted, "to big", "fora", "int he", "area no entries", Ncellls, Nalll, Unsymmetricc, "sig ant digits" — plus, from @jeis4wpi's contribution (#70), "mininum" and "aceptable" in the panic messages of num/linesearch.go and utl/params.go.
• Subject-verb agreement in doc comments: "Init initialize" → "Init initializes", and the same class throughout ("CheckLimits check" → "checks", "GenLabels generate" → "generates", "return a copy" → "returns a copy"). Also "two array" → "two arrays", "slices of integer" → "slices of integers".
• Duplicated words: "along along", "first first", "between between", "if if", "matrix matrix", "MUMPS or MUMPS".
• Missing articles and wrong prepositions: "a quarter of ring" → "a quarter of a ring", "an ODE problems" → "an ODE problem", "ratio between X to Y" → "ratio of X to Y", "in page 61" → "on page 61", "assists on" → "assists with".
• Documentation that contradicted the code, each read at the line before changing it:
  • DistUniform described the normal distribution instead of the uniform one.
  • Surf3dQuarterHemisphere described a "NURBS toroidal surface".
  • The MatrixMarket panic rejected "general" or "unsymmetric" while the guard accepts "symmetric".
  • Both complex sparse solvers' Init documented real systems; their receivers take TripletC.
  • Three rnd functions wrote the half-open interval [low, right) for [low, high).
  • Two code samples labeled the cell count Ncellls for Ncells.

How this release was verified

In the pinned image (Ubuntu 24.04, Go 1.27.1, the libraries recorded in /etc/gosl-libs.txt), on the tagged commit:

• ./gosl all: all 19 packages build and install, go vet reports nothing, every package's tests pass — the run prints SUCCESS!;
• ./gosl fmt reports the same 117 files before and after this release, so nothing here introduced formatting drift (that count is pre-existing: Go 1.27 gofmt against pre-1.19 doc-comment layout);
• every changed line of Go was checked mechanically to differ only inside a comment or a string literal, and codespell with its en-GB-to-en-US dictionary is clean over the tree.

Deliberately not changed

• Misspelled identifiers (dout, hight, anad, the Pfgrey/Pfgrey2 family): renaming them is an API or refactor change, not a prose fix.
• Vendored third-party text: num/qpck/*.f and the QUADPACK README quoted inside num/qpck/README.md, gm/tri/triangle.c, and the SFMT/dSFMT C sources.