Adopt Julia package standards: hygiene tests, release automation, docs - #12
Merged
Merged
Conversation
- Add Aqua hygiene suite (test_aqua.jl) and kernel invariant guards
(test_invariants.jl): per-kernel allocation budgets and concrete
return types. Caught seaice! returning Union{Nothing,Matrix}.
- Add TagBot, CompatHelper and Codecov upload; drop the dead
[extras]/[targets] blocks in favour of test/Project.toml.
- Add doctests (RunSpec, create_experiment_config, nstep_yr) wired up
via DocMeta.setdocmeta!, so examples fail the docs build when stale.
- Add CONTRIBUTING.md, including credit to the original GREB authors.
- Unwrap leftover Pluto `begin ... end` blocks in src/ and fix the
over-indented docstrings they hid.
- Fix 8 references to notebooks/GREB_julia.jl, which no longer exists
(it is GREB_explorer.jl); replace 17 em-dashes; drop 7 pointers into
the gitignored .claude/notes.
- Untrack viz/ and notebooks/ Manifest.toml.
- Add Aqua hygiene suite (test_aqua.jl) and kernel invariant guards
(test_invariants.jl): per-kernel allocation budgets and concrete
return types. Caught seaice! returning Union{Nothing,Matrix}.
- Add TagBot, CompatHelper and Codecov upload; drop the dead
[extras]/[targets] blocks in favour of test/Project.toml.
- Add doctests (RunSpec, create_experiment_config, nstep_yr) wired up
via DocMeta.setdocmeta!, so examples fail the docs build when stale.
- Add CONTRIBUTING.md, including credit to the original GREB authors.
- Unwrap leftover Pluto `begin ... end` blocks in src/ and fix the
over-indented docstrings they hid.
- Fix 8 references to notebooks/GREB_julia.jl, which no longer exists
(it is GREB_explorer.jl); replace 17 em-dashes; drop 7 pointers into
the gitignored .claude/notes.
- Untrack viz/ and notebooks/ Manifest.toml.
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.
begin ... endblocks in src/ and fix the over-indented docstrings they hid.