Use DocStringExtension's TYPEDSIGNATURES for default-free docstring signatures#5680
Merged
Conversation
Replace 317 manually-written docstring signatures with `$(TYPEDSIGNATURES)` from DocStringExtensions so they are generated from the actual method definition rather than maintained by hand. Applied only to single-method docstrings whose signature has no default arguments. Left untouched: signatures with defaults (which TYPEDSIGNATURES would expand into multiple lines), struct constructors, function stubs without methods, name-mismatched docstrings, and metaprogrammed docstrings inside `@eval` loops. `$(TYPEDSIGNATURES)` is evaluated at module-load time, so each affected module gains `using DocStringExtensions: TYPEDSIGNATURES` (or has it appended to its existing DocStringExtensions import). Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
TYPEDSIGNATURES for default-free docstring signatures
Member
Author
|
Some of the previously existing instances of cc @giordano |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR switches many hand-maintained docstring signature blocks over to DocStringExtensions.TYPEDSIGNATURES, so rendered documentation signatures are derived from actual method definitions and stay in sync automatically.
Changes:
- Replaced many docstring “signature header” lines with
$(TYPEDSIGNATURES)for methods that don’t use defaults. - Added
using DocStringExtensions: TYPEDSIGNATURES(or extended existing DocStringExtensions imports) in modules that need it at load/precompile time.
Reviewed changes
Copilot reviewed 159 out of 159 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Utils/Utils.jl | Import TYPEDSIGNATURES for the Utils module. |
| src/Utils/schedules.jl | Use $(TYPEDSIGNATURES) in schedule docstrings. |
| src/Utils/kernel_launching.jl | Use $(TYPEDSIGNATURES) in kernel-launch utilities docstrings. |
| src/Utils/interpolation.jl | Use $(TYPEDSIGNATURES) in interpolation docstrings. |
| src/TurbulenceClosures/vertically_implicit_diffusion_solver.jl | Use $(TYPEDSIGNATURES) in solver docstring. |
| src/TurbulenceClosures/TurbulenceClosures.jl | Import TYPEDSIGNATURES for the TurbulenceClosures module. |
| src/TurbulenceClosures/turbulence_closure_implementations/TKEBasedVerticalDiffusivities/TKEBasedVerticalDiffusivities.jl | Import TYPEDSIGNATURES for this closure implementation module. |
| src/TurbulenceClosures/turbulence_closure_implementations/TKEBasedVerticalDiffusivities/tke_top_boundary_condition.jl | Use $(TYPEDSIGNATURES) in top TKE flux docstring. |
| src/TurbulenceClosures/turbulence_closure_implementations/Smagorinskys/Smagorinskys.jl | Import TYPEDSIGNATURES for the Smagorinskys module. |
| src/TurbulenceClosures/turbulence_closure_implementations/Smagorinskys/lilly_coefficient.jl | Use $(TYPEDSIGNATURES) in stability docstring. |
| src/TurbulenceClosures/turbulence_closure_implementations/isopycnal_skew_symmetric_diffusivity.jl | Use $(TYPEDSIGNATURES) in tapering factor docstring. |
| src/TurbulenceClosures/turbulence_closure_implementations/advective_skew_diffusion.jl | Use $(TYPEDSIGNATURES) in tapering factor docstring. |
| src/TurbulenceClosures/discrete_diffusion_function.jl | Use $(TYPEDSIGNATURES) in DiscreteDiffusionFunction docstring. |
| src/TimeSteppers/TimeSteppers.jl | Import TYPEDSIGNATURES and use it for TimeStepper docstring. |
| src/TimeSteppers/split_runge_kutta.jl | Use $(TYPEDSIGNATURES) in Split RK helper docstrings. |
| src/TimeSteppers/runge_kutta_3.jl | Use $(TYPEDSIGNATURES) in RK3 substep docstring. |
| src/TimeSteppers/quasi_adams_bashforth_2.jl | Use $(TYPEDSIGNATURES) in AB2 step/cache docstrings. |
| src/TimeSteppers/clock.jl | Use $(TYPEDSIGNATURES) in set! docstring. |
| src/Solvers/Solvers.jl | Import TYPEDSIGNATURES and use it in solver docstrings. |
| src/Solvers/poisson_eigenvalues.jl | Use $(TYPEDSIGNATURES) in Poisson eigenvalues docstrings. |
| src/Solvers/index_permutations.jl | Use $(TYPEDSIGNATURES) in (un)permute index docstrings. |
| src/Solvers/fourier_tridiagonal_poisson_solver.jl | Use $(TYPEDSIGNATURES) in set_source_term! docstring. |
| src/Solvers/discrete_transforms.jl | Use $(TYPEDSIGNATURES) in discrete transform utility docstrings. |
| src/Solvers/conjugate_gradient_solver.jl | Use $(TYPEDSIGNATURES) in CG solve docstring. |
| src/Solvers/batched_tridiagonal_solver.jl | Use $(TYPEDSIGNATURES) in batched tridiagonal solve docstring. |
| src/Simulations/time_step_wizard.jl | Use $(TYPEDSIGNATURES) in new_time_step docstring. |
| src/Simulations/Simulations.jl | Import TYPEDSIGNATURES for the Simulations module. |
| src/Simulations/simulation.jl | Use $(TYPEDSIGNATURES) in Simulation API docstrings. |
| src/Simulations/run.jl | Use $(TYPEDSIGNATURES) in run/initialize docstrings. |
| src/Simulations/callback.jl | Use $(TYPEDSIGNATURES) in callback init/finalize docstrings. |
| src/OutputWriters/windowed_time_average.jl | Use $(TYPEDSIGNATURES) in time-average output wrapping docstring. |
| src/OutputWriters/OutputWriters.jl | Import TYPEDSIGNATURES for the OutputWriters module. |
| src/OutputWriters/output_writer_utils.jl | Use $(TYPEDSIGNATURES) in output writer utility docstrings. |
| src/OutputWriters/jld2_writer.jl | Use $(TYPEDSIGNATURES) in JLD2 writer docstrings. |
| src/OutputWriters/checkpointer.jl | Use $(TYPEDSIGNATURES) in checkpoint-path/loading docstrings. |
| src/OutputWriters/averaged_specified_times.jl | Use $(TYPEDSIGNATURES) in schedule validation docstring. |
| src/OutputReaders/time_series_interpolated_field.jl | Use $(TYPEDSIGNATURES) in interpolation wrapper docstring. |
| src/OutputReaders/OutputReaders.jl | Import TYPEDSIGNATURES and use it in output reader docstrings. |
| src/OutputReaders/field_time_series.jl | Use $(TYPEDSIGNATURES) in time-series helpers docstrings. |
| src/OutputReaders/combining_field_time_series.jl | Use $(TYPEDSIGNATURES) in distributed combining helpers docstrings. |
| src/OrthogonalSphericalShellGrids/rotated_latitude_longitude_grid.jl | Use $(TYPEDSIGNATURES) in rotation helper docstring. |
| src/OrthogonalSphericalShellGrids/OrthogonalSphericalShellGrids.jl | Import TYPEDSIGNATURES and use it in serialization helper docstring. |
| src/OrthogonalSphericalShellGrids/generate_tripolar_coordinates.jl | Use $(TYPEDSIGNATURES) in tripolar coordinate generator docstring. |
| src/OrthogonalSphericalShellGrids/conformal_cubed_sphere_panel.jl | Use $(TYPEDSIGNATURES) in circulation operator docstring. |
| src/Operators/vorticity_operators.jl | Use $(TYPEDSIGNATURES) in vorticity operator docstring. |
| src/Operators/vector_rotation_operators.jl | Use $(TYPEDSIGNATURES) in vector rotation operator docstrings. |
| src/Operators/Operators.jl | Import TYPEDSIGNATURES for the Operators module. |
| src/Operators/laplacian_operators.jl | Use $(TYPEDSIGNATURES) in Laplacian operator docstring. |
| src/Operators/interpolation_utils.jl | Use $(TYPEDSIGNATURES) in interpolation utility docstrings. |
| src/Operators/divergence_operators.jl | Use $(TYPEDSIGNATURES) in divergence operator docstrings. |
| src/MultiRegion/MultiRegion.jl | Extend DocStringExtensions import to include TYPEDSIGNATURES. |
| src/MultiRegion/multi_region_grid.jl | Use $(TYPEDSIGNATURES) in multi-region grid docstrings. |
| src/MultiRegion/multi_region_field.jl | Use $(TYPEDSIGNATURES) in multi-region field docstring. |
| src/Models/VarianceDissipationComputations/VarianceDissipationComputations.jl | Import TYPEDSIGNATURES for this module. |
| src/Models/VarianceDissipationComputations/flatten_dissipation_fields.jl | Use $(TYPEDSIGNATURES) in flattening helper docstring. |
| src/Models/VarianceDissipationComputations/compute_dissipation.jl | Use $(TYPEDSIGNATURES) in dissipation compute docstring. |
| src/Models/ShallowWaterModels/ShallowWaterModels.jl | Import TYPEDSIGNATURES and use it in ShallowWaterModel docstrings. |
| src/Models/ShallowWaterModels/shallow_water_rk3_substep.jl | Use $(TYPEDSIGNATURES) in RK3 substep docstring. |
| src/Models/ShallowWaterModels/shallow_water_advection_operators.jl | Use $(TYPEDSIGNATURES) in shallow-water advection operator docstrings. |
| src/Models/ShallowWaterModels/shallow_water_ab2_step.jl | Use $(TYPEDSIGNATURES) in AB2 step docstring. |
| src/Models/ShallowWaterModels/compute_shallow_water_tendencies.jl | Use $(TYPEDSIGNATURES) in tendencies docstring. |
| src/Models/ShallowWaterModels/cache_shallow_water_tendencies.jl | Use $(TYPEDSIGNATURES) in caching docstring. |
| src/Models/set_model.jl | Use $(TYPEDSIGNATURES) in model set! docstring. |
| src/Models/NonhydrostaticModels/pressure_correction.jl | Use $(TYPEDSIGNATURES) in pressure correction docstring. |
| src/Models/NonhydrostaticModels/NonhydrostaticModels.jl | Use $(TYPEDSIGNATURES) in NonhydrostaticModel interface docstrings. |
| src/Models/NonhydrostaticModels/nonhydrostatic_rk3_substep.jl | Use $(TYPEDSIGNATURES) in RK3/pressure-correction substep docstrings. |
| src/Models/NonhydrostaticModels/nonhydrostatic_ab2_step.jl | Use $(TYPEDSIGNATURES) in AB2/pressure-correction docstrings. |
| src/Models/NonhydrostaticModels/enforce_net_zero_transport.jl | Use $(TYPEDSIGNATURES) in transport enforcement docstring. |
| src/Models/NonhydrostaticModels/compute_nonhydrostatic_tendencies.jl | Use $(TYPEDSIGNATURES) in compute tendencies docstring. |
| src/Models/NonhydrostaticModels/cache_nonhydrostatic_tendencies.jl | Use $(TYPEDSIGNATURES) in caching docstring. |
| src/Models/Models.jl | Import TYPEDSIGNATURES for the Models module and use it in docstrings. |
| src/Models/LagrangianParticleTracking/LagrangianParticleTracking.jl | Import TYPEDSIGNATURES for particle tracking module. |
| src/Models/LagrangianParticleTracking/lagrangian_particle_advection.jl | Use $(TYPEDSIGNATURES) in particle advection/boundary helper docstrings. |
| src/Models/interleave_communication_and_computation.jl | Use $(TYPEDSIGNATURES) in kernel-parameter helper docstrings. |
| src/Models/HydrostaticFreeSurfaceModels/z_star_coordinate.jl | Use $(TYPEDSIGNATURES) in z-star coordinate helper docstrings. |
| src/Models/HydrostaticFreeSurfaceModels/vertical_vorticity.jl | Use $(TYPEDSIGNATURES) in vorticity op docstring. |
| src/Models/HydrostaticFreeSurfaceModels/update_hydrostatic_free_surface_model_state.jl | Use $(TYPEDSIGNATURES) in state update helper docstrings. |
| src/Models/HydrostaticFreeSurfaceModels/SplitExplicitFreeSurfaces/SplitExplicitFreeSurfaces.jl | Import TYPEDSIGNATURES for split-explicit free-surface module. |
| src/Models/HydrostaticFreeSurfaceModels/SplitExplicitFreeSurfaces/barotropic_split_explicit_corrector.jl | Use $(TYPEDSIGNATURES) in barotropic corrector docstrings. |
| src/Models/HydrostaticFreeSurfaceModels/pcg_implicit_free_surface_solver.jl | Use $(TYPEDSIGNATURES) in implicit free-surface operators docstrings. |
| src/Models/HydrostaticFreeSurfaceModels/HydrostaticFreeSurfaceModels.jl | Extend DocStringExtensions import to include TYPEDSIGNATURES; update interface docstrings. |
| src/Models/HydrostaticFreeSurfaceModels/hydrostatic_free_surface_rk_step.jl | Use $(TYPEDSIGNATURES) in RK substep docstrings. |
| src/Models/HydrostaticFreeSurfaceModels/hydrostatic_free_surface_ab2_step.jl | Use $(TYPEDSIGNATURES) in AB2 step docstrings. |
| src/Models/HydrostaticFreeSurfaceModels/explicit_free_surface.jl | Use $(TYPEDSIGNATURES) in free-surface tendency docstring. |
| src/Models/HydrostaticFreeSurfaceModels/compute_w_from_continuity.jl | Use $(TYPEDSIGNATURES) in grid vertical-velocity update docstring. |
| src/Models/HydrostaticFreeSurfaceModels/compute_hydrostatic_free_surface_tendencies.jl | Use $(TYPEDSIGNATURES) in momentum/tracer tendency docstrings. |
| src/Models/HydrostaticFreeSurfaceModels/compute_hydrostatic_free_surface_buffers.jl | Use $(TYPEDSIGNATURES) in distributed buffer compute docstrings. |
| src/Models/HydrostaticFreeSurfaceModels/cache_hydrostatic_free_surface_tendencies.jl | Use $(TYPEDSIGNATURES) in tendency caching docstrings. |
| src/Models/HydrostaticFreeSurfaceModels/boundary_targeted_transport.jl | Use $(TYPEDSIGNATURES) in targeted transport helpers docstrings. |
| src/Models/HydrostaticFreeSurfaceModels/barotropic_pressure_correction.jl | Use $(TYPEDSIGNATURES) in barotropic correction docstrings. |
| src/Models/forcing_operation.jl | Use $(TYPEDSIGNATURES) in forcing operation docstring. |
| src/Models/buoyancy_operation.jl | Use $(TYPEDSIGNATURES) in buoyancy operation/field/frequency docstrings. |
| src/Models/BulkDragBoundaryConditions.jl | Import TYPEDSIGNATURES and use it in bulk-drag BC docstring. |
| src/Models/boundary_transport.jl | Use $(TYPEDSIGNATURES) in boundary transport initializer docstring. |
| src/Models/boundary_condition_operation.jl | Use $(TYPEDSIGNATURES) in BC operation docstring. |
| src/ImmersedBoundaries/mask_immersed_field.jl | Use $(TYPEDSIGNATURES) in immersed masking docstrings. |
| src/ImmersedBoundaries/ImmersedBoundaries.jl | Import TYPEDSIGNATURES for the ImmersedBoundaries module. |
| src/ImmersedBoundaries/immersed_boundary_interface.jl | Use $(TYPEDSIGNATURES) in immersed/inactive cell docstrings. |
| src/ImmersedBoundaries/immersed_boundary_condition.jl | Use $(TYPEDSIGNATURES) in immersed BC regularization docstring. |
| src/ImmersedBoundaries/grid_fitted_bottom.jl | Use $(TYPEDSIGNATURES) in materialize docstring. |
| src/ImmersedBoundaries/active_cells_map.jl | Use $(TYPEDSIGNATURES) in index conversion docstring. |
| src/Grids/vertical_discretization.jl | Use $(TYPEDSIGNATURES) in vertical discretization docstring. |
| src/Grids/rectilinear_grid.jl | Use $(TYPEDSIGNATURES) in grid mutation helpers docstrings. |
| src/Grids/orthogonal_spherical_shell_grid.jl | Use $(TYPEDSIGNATURES) in metric halo / geometry helpers docstrings. |
| src/Grids/nodes_and_spacings.jl | Use $(TYPEDSIGNATURES) in minimum spacing docstrings. |
| src/Grids/inactive_node.jl | Use $(TYPEDSIGNATURES) in (in)active/peripheral/boundary node docstrings. |
| src/Grids/Grids.jl | Extend DocStringExtensions import to include TYPEDSIGNATURES. |
| src/Grids/grid_utils.jl | Use $(TYPEDSIGNATURES) in grid utility docstrings. |
| src/Grids/coordinate_transformations.jl | Use $(TYPEDSIGNATURES) in coordinate transformation docstrings. |
| src/Grids/abstract_grid.jl | Use $(TYPEDSIGNATURES) in grid interface docstrings. |
| src/Forcings/multiple_forcings.jl | Use $(TYPEDSIGNATURES) in MultipleForcings docstring. |
| src/Forcings/model_forcing.jl | Use $(TYPEDSIGNATURES) in forcing materialization docstrings. |
| src/Forcings/Forcings.jl | Import TYPEDSIGNATURES for the Forcings module. |
| src/Forcings/forcing.jl | Use $(TYPEDSIGNATURES) in Forcing constructors docstrings. |
| src/Forcings/continuous_forcing.jl | Use $(TYPEDSIGNATURES) in materialize_forcing docstring. |
| src/Fields/set!.jl | Use $(TYPEDSIGNATURES) in set! docstring. |
| src/Fields/scans.jl | Use $(TYPEDSIGNATURES) in reduction/accumulation docstrings. |
| src/Fields/regridding_fields.jl | Use $(TYPEDSIGNATURES) in regrid! docstring. |
| src/Fields/interpolate.jl | Use $(TYPEDSIGNATURES) in interpolation helpers docstrings. |
| src/Fields/Fields.jl | Import TYPEDSIGNATURES for the Fields module and use it in docstrings. |
| src/Fields/field.jl | Use $(TYPEDSIGNATURES) in field/view/interior/compute helpers docstrings. |
| src/Fields/field_tuples.jl | Use $(TYPEDSIGNATURES) in field tuple utilities docstrings. |
| src/Fields/field_indices.jl | Use $(TYPEDSIGNATURES) in index restriction docstring. |
| src/Fields/abstract_field.jl | Use $(TYPEDSIGNATURES) in field sizing docstrings. |
| src/DistributedComputations/partition_assemble.jl | Use $(TYPEDSIGNATURES) in partition/assemble docstrings. |
| src/DistributedComputations/DistributedComputations.jl | Import TYPEDSIGNATURES for the DistributedComputations module. |
| src/DistributedComputations/distributed_grids.jl | Use $(TYPEDSIGNATURES) in distributed grid reconstruction docstrings. |
| src/DistributedComputations/distributed_fields.jl | Use $(TYPEDSIGNATURES) in distributed field sync/reconstruct docstrings. |
| src/DistributedComputations/distributed_architectures.jl | Use $(TYPEDSIGNATURES) in partitioning/topology helper docstrings. |
| src/DistributedComputations/communication_buffers.jl | Use $(TYPEDSIGNATURES) in comms buffer API docstrings. |
| src/Diagnostics/nan_checker.jl | Use $(TYPEDSIGNATURES) in NaN checker helper docstring. |
| src/Diagnostics/Diagnostics.jl | Import TYPEDSIGNATURES for the Diagnostics module. |
| src/Diagnostics/cfl.jl | Use $(TYPEDSIGNATURES) in CFL constructors docstrings. |
| src/BuoyancyFormulations/seawater_buoyancy.jl | Use $(TYPEDSIGNATURES) in buoyancy derivative docstrings. |
| src/BuoyancyFormulations/BuoyancyFormulations.jl | Import TYPEDSIGNATURES for the BuoyancyFormulations module. |
| src/BoundaryConditions/perturbation_advection.jl | Use $(TYPEDSIGNATURES) in perturbation advection helpers docstrings. |
| src/BoundaryConditions/fill_halo_regions.jl | Use $(TYPEDSIGNATURES) in halo fill fallback docstring. |
| src/BoundaryConditions/fill_halo_kernels.jl | Use $(TYPEDSIGNATURES) in BC kernel construction docstring. |
| src/BoundaryConditions/continuous_boundary_function.jl | Use $(TYPEDSIGNATURES) in BC regularization docstring. |
| src/BoundaryConditions/compute_flux_bcs.jl | Use $(TYPEDSIGNATURES) in flux BC compute docstrings. |
| src/BoundaryConditions/BoundaryConditions.jl | Import TYPEDSIGNATURES for the BoundaryConditions module. |
| src/BoundaryConditions/boundary_condition_classifications.jl | Use $(TYPEDSIGNATURES) in zipper pivot docstring. |
| src/Biogeochemistry.jl | Import TYPEDSIGNATURES for the Biogeochemistry module and use it in docstrings. |
| src/Architectures.jl | Import TYPEDSIGNATURES and use it in architecture docstrings. |
| src/Advection/weno_interpolants.jl | Use $(TYPEDSIGNATURES) in WENO helper docstrings. |
| src/Advection/reconstruction_coefficients.jl | Use $(TYPEDSIGNATURES) in coefficient helper docstring. |
| src/Advection/momentum_advection_operators.jl | Use $(TYPEDSIGNATURES) in momentum advection operator docstrings. |
| src/Advection/materialize_advection.jl | Use $(TYPEDSIGNATURES) in materialize advection docstring. |
| src/Advection/immersed_advective_fluxes.jl | Use $(TYPEDSIGNATURES) in conditional flux docstring. |
| src/Advection/flux_form_advection.jl | Use $(TYPEDSIGNATURES) in FluxFormAdvection docstring. |
| src/Advection/cell_advection_timescale.jl | Use $(TYPEDSIGNATURES) in advection timescale docstring. |
| src/Advection/Advection.jl | Extend DocStringExtensions import to include TYPEDSIGNATURES. |
| src/Advection/adaptive_implicit_vertical_advection.jl | Use $(TYPEDSIGNATURES) in advection timestep updater docstring. |
| src/Advection/adapt_advection_order.jl | Use $(TYPEDSIGNATURES) in advection order adapter docstring. |
| src/AbstractOperations/grid_validation.jl | Use $(TYPEDSIGNATURES) in grid validation docstrings. |
| src/AbstractOperations/grid_metrics.jl | Use $(TYPEDSIGNATURES) in grid metrics docstrings. |
| src/AbstractOperations/derivatives.jl | Use $(TYPEDSIGNATURES) in derivative constructors docstrings. |
| src/AbstractOperations/at.jl | Use $(TYPEDSIGNATURES) in index intersection docstring. |
| src/AbstractOperations/AbstractOperations.jl | Import TYPEDSIGNATURES for the AbstractOperations module and use it in docstrings. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
navidcy
reviewed
Jun 13, 2026
Co-authored-by: Copilot Autofix powered by AI <[email protected]> Co-authored-by: Navid C. Constantinou <[email protected]>
navidcy
approved these changes
Jun 13, 2026
navidcy
reviewed
Jun 13, 2026
Member
No indentation is needed. |
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Member
|
I think we merge if CI passes |
Member
|
I went through to see for other instances and ended up doing some cleanup commits that are unrelated with the TYPEDSIGNATURES that the PR is dealing with; sorry :( |
Collaborator
|
we modernize and automate. Very nice! :) |
giordano
reviewed
Jun 13, 2026
…ns.jl into tc/docstring-extensions
Member
|
merge? |
giordano
reviewed
Jun 14, 2026
giordano
approved these changes
Jun 14, 2026
Member
|
I'm merging this. Thanks @tomchor! |
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.
This PR replaces many (317 in the first draft) manually-written docstring signatures with
$(TYPEDSIGNATURES)from DocStringExtensions, so the rendered signature is generated from the actual method definition instead of maintained by hand.This conversion is applied to docstrings whose signature has no default arguments since DocStringExtensions currently cannot produce docstring signatures that indicate the default values (see JuliaDocs/DocStringExtensions.jl#107).
Beyond defaults, the following were deliberately left untouched (for correctness, not omission):
structdefinitionsTYPEDSIGNATURESon a type documents its constructor(s) — messy / multi-constructor outputf(a, b, c)but the method isf(a, b, c=…)— would expand to multiple linesfunction foo end@eval) docstringsTYPEDSIGNATUREScan't resolve theseImports
$(TYPEDSIGNATURES)is evaluated at module-load time, so each affected module must have it in scope or precompilation fails. This PR addsusing DocStringExtensions: TYPEDSIGNATURESto each module that needed it (and appendsTYPEDSIGNATURESto the existing DocStringExtensions import inAdvection,Grids,HydrostaticFreeSurfaceModels, andMultiRegion).Additional fixes
concatenate_local_sizesinsrc/DistributedComputations/partition_assemble.jlthat incorrectly referencedgridanddim(argument names from an old implementation) instead of the actuallocal_sizeandarchparameters.🤖 Generated with Claude Code