Repository navigation
Conversation
DocStringExtensions 0.10 prints default argument values with MethodSignatures(; defaults = true). Use it for docstrings whose signatures were written by hand only to show defaults. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
giordano
reviewed
Oct 15, 2026
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Keep the generated signatures for ConformalCubedSphereGrid and TripolarGrid; they pick up the keywords main added to the hand-written ones. Restore the DocStringExtensions compat to "0.10": the previous merge took main's "0.8, 0.9, 0.10", which lets 0.9 resolve and breaks precompilation on MethodSignatures(; defaults = true). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Temporarily source Makie, KernelDensity, FFTA and TiffImages (test and docs) and Documenter (docs) from branches that allow DocStringExtensions 0.10, so CI can run and build a docs preview. Documenter 1.19 fixes the regex error that capped it at 1.17. Drop these sources once the releases are out. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #6263 +/- ##
=======================================
Coverage 76.13% 76.13%
=======================================
Files 460 460
Lines 29618 29618
=======================================
+ Hits 22549 22550 +1
+ Misses 7069 7068 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Member
|
Documenter just released their new version, so we're getting closer :) |
Resolve conflicts by taking main's explicit import blocks with MethodSignatures added, and restore $(MethodSignatures(; defaults = true)) in the docstrings main edited (PartialCellVerticalBoundaries, PartialCellBottom, LagrangianParticles, JLD2Writer, ScalarDiffusivity). Drop the triad ISSD file that main removed. Use Documenter 1.20 and drop the Documenter master pin. Pin FFTA to the commit that allows DocStringExtensions 0.10 at v0.3.1, since the dependabot branch was deleted and Makie still caps FFTA below 0.3.2. Drop the KernelDensity pin, whose branch was also deleted; registered KernelDensity no longer depends on DocStringExtensions. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Makie 0.24.17 allows DocStringExtensions 0.10 and no longer depends on FFTA, so neither needs to be pinned to an unreleased revision. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
navidcy
marked this pull request as ready for review
November 8, 2026 07:07
…DocStringExtensions 0.10 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
Author
|
This is ready now; all issue with deps have been resolved. |
…DocStringExtensions 0.10 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This branch has not been deployed
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.
Bumps to
DocStringExtensions = "0.10"and uses$(MethodSignatures(; defaults = true))(JuliaDocs/DocStringExtensions.jl#194) for 143 docstrings whose signatures were hand-written only to show defaults. Many of those had gone stale (e.g.FT = Float64instead ofOceananigans.defaults.FloatType, missing keywords).41 hand-written signatures stay, where the generated one would mislead: methods dispatching on a specific type (
set!(model::NonhydrostaticModel; ...)), keywords hidden behindkwargs...(NetCDFWriter), and docstrings attached to a different method (CFL).The
;inMethodSignatures(; defaults = true)is needed: without it ExplicitImports readsdefaults = trueas an assignment and flags the import ofOceananigans.defaultsas stale.🤖 Generated with Claude Code