Skip to content

Add DocStringExtensions v0.10 compat entry + Bump version - #574

Merged
ranocha merged 1 commit into
JuliaSIMD:mainfrom
navidcy:patch-1
Nov 11, 2026
Merged

ranocha merged 1 commit into
JuliaSIMD:mainfrom
navidcy:patch-1

Conversation

@navidcy

@navidcy navidcy commented Oct 16, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@maximilian-gelbrecht

maximilian-gelbrecht commented Nov 11, 2026 •

Copy link
Copy Markdown

Could this please be reviewed and merged? We also need this.

E.g. @ranocha

@codecov

codecov Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.52%. Comparing base (369cebc) to head (faaf31b).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #574      +/-   ##
==========================================
+ Coverage   83.81%   87.52%   +3.71%     
==========================================
  Files          40       40              
  Lines        9574     9697     +123     
==========================================
+ Hits         8024     8487     +463     
+ Misses       1550     1210     -340     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ranocha ranocha left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'm not really a maintainer of this repo, but I have the access rights to do so. The CI failures are already present on main, so I will merge this PR and release a new version.

@ranocha
ranocha merged commit 6e0cac8 into JuliaSIMD:main Nov 11, 2026
67 of 76 checks passed
@milankl

milankl commented Nov 12, 2026

Copy link
Copy Markdown

FYI in SpeedyWeather we ran into some problems because of dropping v0.9 compat when in environments with other packages that don't yet support v0.10. To have both @navidcy did SpeedyWeather/SpeedyWeather.jl#1398

navidcy added a commit to NumericalEarth/NumericalEarth.jl that referenced this pull request Nov 14, 2026
JuliaSIMD/LoopVectorization.jl#574 is released in v0.12.176, so the fork pin is no
longer needed. LoopVectorization was a direct test dependency only so the pin
could apply; nothing uses it directly.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
navidcy added a commit to NumericalEarth/NumericalEarth.jl that referenced this pull request Nov 14, 2026
JuliaSIMD/LoopVectorization.jl#574 is released in v0.12.176, and LoopVectorization
was a direct dependency of docs, examples, and test only so a fork pin could apply.
Registered Breeze 0.15 supports Oceananigans 0.117 and DocStringExtensions 0.10;
Breeze `main` now requires Oceananigans 0.118, and docs, examples, and test share
one workspace manifest, so the pins broke resolution for all of them.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
navidcy added a commit to NumericalEarth/NumericalEarth.jl that referenced this pull request Nov 14, 2026
JuliaSIMD/LoopVectorization.jl#574 is released in v0.12.176, so the fork pin is no
longer needed. LoopVectorization was a direct test dependency only so the pin
could apply; nothing uses it directly.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
navidcy added a commit to NumericalEarth/NumericalEarth.jl that referenced this pull request Nov 14, 2026
* Generate docstring signatures with default values

Use DocStringExtensions v0.10's `MethodSignatures(defaults = true)` for the
105 docstrings whose signatures were written by hand only to show default
argument values, and require DocStringExtensions 0.10.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Take CloudMicrophysics from CliMA/CloudMicrophysics.jl#817 in docs and examples

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Update the registry before resolving the docs environment

The self-hosted runner's depot persists between runs, so its General registry
lags behind newly registered versions (e.g. ClimaParams 1.3.4).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Require Documenter 1.20 and drop branch-pinned sources

Documenter 1.20 and Makie releases allow DocStringExtensions 0.10, so the
docs and examples environments no longer need Documenter, Makie, or
CloudMicrophysics from git branches.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Allow Breeze 0.15, the first release compatible with DocStringExtensions 0.10

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Require Breeze 0.15 and use its `continuity_density`

Breeze 0.15 renames `dynamics_density` to `continuity_density` and is the first
release compatible with DocStringExtensions 0.10, so earlier Breeze releases
are dropped.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Take unreleased packages with DocStringExtensions 0.10 compat from git

The docs, examples and test environments take SpeedyWeather (and its
subpackages), Terrarium and LoopVectorization from branches that allow
DocStringExtensions 0.10 and Oceananigans 0.117. The test environment
also takes Breeze from main, which allows Oceananigans 0.117.2 as
required by OceanBioME 0.21.1. Each pin carries a TODO to remove it once
released.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Take released SpeedyWeather subpackages; Breeze from main in docs and examples

SpeedyWeatherInternals 1.0.2 and RingGrids, SpeedyTransforms and
LowerTriangularArrays 1.0.1 allow DocStringExtensions 0.10, so their
branch pins are dropped. Docs and examples now require Oceananigans
0.117.2, which no Breeze release allows yet.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Drop SpeedyWeather branch pin in docs and test now that 0.24 is released

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Restore docs/Project.toml sources comments clobbered by Pkg.resolve

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Drop LoopVectorization fork pin now that 0.12.176 is released

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Allow DocStringExtensions v0.9 again, show default values with v0.10

Define SIGNATURES and TYPEDSIGNATURES in NumericalEarth, following
CliMA/Oceananigans.jl#6490: with DocStringExtensions v0.10 they show
default argument values, with v0.9 they fall back to plain signatures.
All modules and extensions import them from NumericalEarth, and the
MethodSignatures(defaults = true) docstrings use SIGNATURES.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Group SIGNATURES imports with the other NumericalEarth imports

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Drop the LoopVectorization dependency and Breeze pins

JuliaSIMD/LoopVectorization.jl#574 is released in v0.12.176, and LoopVectorization
was a direct dependency of docs, examples, and test only so a fork pin could apply.
Registered Breeze 0.15 supports Oceananigans 0.117 and DocStringExtensions 0.10;
Breeze `main` now requires Oceananigans 0.118, and docs, examples, and test share
one workspace manifest, so the pins broke resolution for all of them.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Update Project.toml

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
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.

4 participants