Skip to content

Code cleanup: Runic formatting and typo fixes#38

Merged
ChrisRackauckas merged 3 commits into
luchr:masterfrom
ChrisRackauckas-Claude:code-runic-typos
Jun 13, 2026
Merged

Code cleanup: Runic formatting and typo fixes#38
ChrisRackauckas merged 3 commits into
luchr:masterfrom
ChrisRackauckas-Claude:code-runic-typos

Conversation

@ChrisRackauckas-Claude

Copy link
Copy Markdown

This is the split-out code half of #37 (the other half is the CI infrastructure PR — see cross-link below). It contains only changes that modify code/text content, with no CI or infrastructure changes.

What this PR contains

  1. Runic formatting of all Julia files. Every .jl file in src/, examples/, doc/, deps/, and test/ is reformatted to the canonical Runic style (Runic v1.7.0). No behavioral changes.
  2. Fix for invalid pre-1.0 broadcast syntax in two ROBER examples. The old 10.^[...] syntax (valid only on Julia 0.x) is a parse error on every Julia 1.x. Fixed to the modern broadcast form so the example files actually parse.
  3. Typo corrections in docstrings, docs, and comments, plus a _typos.toml config. The _typos.toml:
    • excludes the vendored Fortran sources (*.f, *.f90), LICENSE.md, and generated example artifacts (examples/AdvancedExamples/texFiles, *.ipynb, *.mw);
    • allowlists legitimate Fortran identifiers (contex, contro, implct, nd, the RTO-tokenized option) and author/journal names (Stoer, Numer. Math.).

Untouched: LICENSE.md, all vendored Fortran solver sources, and all author attributions are left exactly as-is.

Local test evidence

All runs done locally via juliaup, fresh Manifest.toml, Pkg.instantiate() + Pkg.build("ODEInterface") + Pkg.test():

  • Julia 1.10.11Testing ODEInterface tests passed (exit 0)
  • Julia release (1.12.5)Testing ODEInterface tests passed (exit 0)

Enforcement tools on this branch:

  • Runic v1.7.0 --check over all 56 .jl files — clean (no reformatting needed).
  • typos (typos-cli 1.47.0) with _typos.toml — clean (exit 0). Note: typos reports one false positive (seh) in appveyor.yml, a mingw toolchain path component; appveyor.yml is untouched by this PR and is removed by the companion CI PR, so the SpellCheck workflow (which lives in the CI PR) is clean once that PR's appveyor.yml deletion lands.

Related

CI infrastructure split into the companion PR (GitHub Actions, dependabot, TagBot, CompatHelper, compat bounds, README badges, Travis/AppVeyor removal). See the CI PR linked in the comments.

This PR should be ignored until reviewed by @ChrisRackauckas.

🤖 Generated with Claude Code

@ChrisRackauckas-Claude

Copy link
Copy Markdown
Author

CI infrastructure split into the companion PR #39 (GitHub Actions, dependabot, TagBot/CompatHelper, Project.toml compat bounds, README badges, Travis/AppVeyor removal). #39 depends on this PR — merge this one first so the FormatCheck/SpellCheck workflows there pass.

`10.^[...]` is a parse error on all Julia 1.x versions; use `10.0 .^ [...]`.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Vendored Fortran sources, LICENSE.md, and generated example artifacts
(tex/ipynb/mw) are excluded from the typos check; Fortran identifiers
(contex, contro, implct, nd) and citation names (Stoer, Numer. Math.)
are allowlisted.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
@ChrisRackauckas ChrisRackauckas marked this pull request as ready for review June 13, 2026 08:46
@ChrisRackauckas ChrisRackauckas merged commit 616b820 into luchr:master Jun 13, 2026
8 of 9 checks passed
@ChrisRackauckas-Claude

Copy link
Copy Markdown
Author

Rebased onto the merged #39 (now on master). The only conflict point was README.md, resolved by keeping both master's new GitHub Actions/Codecov badges and this PR's typo fix (informationsinformation). git diff --stat origin/master..code-runic-typos now shows only code-content files (src/*.jl, examples/*, doc/*, test/runtests.jl, README.md, VERSIONS.md, _typos.toml) with no workflow/Project.toml/badge churn.

Local verification before pushing:

CI on the rebased head is also green: format-check ✓, Spell Check ✓, Downgrade ✓, Tests ✓ (min/pre/1 on ubuntu + windows + macOS).

🤖 Generated with Claude Code

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