Document exported strategy kind constants#94
Merged
ChrisRackauckas merged 1 commit intoJul 10, 2026
Conversation
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
ChrisRackauckas
marked this pull request as ready for review
July 10, 2026 19:08
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.
Summary
Ignore this PR until reviewed by @ChrisRackauckas.
This PR completes public API documentation coverage for the exported
StrategyKindenum values by:@enumdefinition insrc/kinds.jlKIND_*constants to the rendered docs via a@docsblock indocs/src/strategies.mdBase.Docsmetadata and appears in a docs@docsblockThe per-constant docs use detached
@doconly because Julia 1.10's@enumrejects inline docstrings for individual enum values.Validation
git diff --checktimeout 3600 /home/crackauc/.juliaup/bin/julia +1.10 --project=. --startup-file=no -e 'using Runic; Runic.main(["--check", "src/kinds.jl", "test/qa/qa.jl", "docs/src/strategies.md"])'missing source docs: Symbol[],missing rendered docs: Symbol[]timeout 3600 /home/crackauc/.juliaup/bin/julia +1.10 --project=. --startup-file=no -e 'using Pkg; Pkg.test()'passed:Core/core_tests.jl | 105036 105036timeout 3600 /home/crackauc/.juliaup/bin/julia +1.10 --project=. --startup-file=no -e 'using Pkg; ENV["GROUP"] = "QA"; Pkg.test()'passed:QA/qa.jl | 18 18,QA/static_analysis_tests.jl | 34 34Docs build note: the official local docs command failed on linkcheck with HTTP 429 for
https://github.com/SciML/FindFirstFunctions.jl/blob/main/bench/analyze.jl. I reproduced the same failure fromorigin/mainin an extracted clean copy, so it is not introduced by this branch. The GitHub Documentation check for this PR passed.Remote CI note: the
benchmark / Benchmarkscheck failed because AirspeedVelocity's temporary benchmark environment cannot loadStableRNGsfrombenchmark/benchmarks.jl. The samePackage StableRNGs not found in current pathfailure appears in prior benchmark run29074814177, so this is a pre-existing benchmark workflow dependency issue rather than a regression from this docs PR.