Document exported Catalyst APIs - #1501
Merged
ChrisRackauckas merged 7 commits intoJul 21, 2026
Merged
Conversation
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Member
Author
|
Updated the QA SciMLTesting compat bound to 2.2 in Local verification:
Commit: Runic was not run because this patch only changes a TOML compat entry, not Julia source. |
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Member
Author
|
Updated the branch to restore the QA compat floor to Local validation:
|
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
ChrisRackauckas
marked this pull request as ready for review
July 21, 2026 15:39
This was referenced Jul 21, 2026
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 draft PR should be ignored until reviewed by @ChrisRackauckas.
Summary
rendered = true, while ignoring dependency-owned reexports for source/rendered API-docs QA instead of documenting those upstream-owned names in Catalyst.@autodocsmodule plumbing.masterinto the branch without rewriting history.Verification
git diff --checkpassed with no output.timeout 3600 ~/.juliaup/bin/julia +1.10 --project=. -e 'using Runic; exit(Runic.main(ARGS))' -- --check --diff $(git diff --name-only origin/master | grep -E '\.(jl|md)$')passed with no output.timeout 3600 ~/.juliaup/bin/julia +1.10 --project=test/qa -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate(); include("test/qa/qa.jl")'passed:Quality Assurance | 13 pass, 4 broken, 17 totalin3m30.6s.run_api_docs(Catalyst; rendered=true, ignore=DEPENDENCY_OWNED_PUBLIC_NAMES, rendered_ignore=DEPENDENCY_OWNED_PUBLIC_NAMES)->Public API documentation | 2 pass, 2 total.grep -R "\[sources\]\|path *=\|url *=\|test/Project.toml" -n Project.toml docs/Project.toml test/qa/Project.toml test/Project.tomlproduced no output.SignalDecompositionhas no compatible version under theDynamicalSystems v3.6.8,StaticArrays, and Julia 1.10SparseArraysconstraints.SetupBuildDirectory,Doctest: skipped,ExpandTemplates) but exceededtimeout 3600; I terminated the still-CPU-bound Julia process after the timeout wrapper had elapsed over one hour.No full
Pkg.test()run was attempted; this PR is scoped to docs/docstrings/rendered QA.