Skip to content

Enable rendered public API docs QA - #69

Merged
ChrisRackauckas merged 1 commit into
SciML:mainfrom
ChrisRackauckas-Claude:agent/fsp-public-docs-qa
Jul 21, 2026
Merged

Enable rendered public API docs QA#69
ChrisRackauckas merged 1 commit into
SciML:mainfrom
ChrisRackauckas-Claude:agent/fsp-public-docs-qa

Conversation

@ChrisRackauckas-Claude

Copy link
Copy Markdown
Member

Ignore this PR until reviewed by @ChrisRackauckas.

Summary

  • Enable SciMLTesting rendered public API docs coverage for FiniteStateProjection.jl.
  • Pass the existing Catalyst re-export ignore list to both docstring and rendered-docs checks.
  • No source behavior, docs pages, or package tests were changed.

Audit

Package-owned exported/public API audited:

  • FSPSystem
  • DefaultIndexHandler
  • SteadyState

All three already have source docstrings and rendered docs entries. Catalyst re-exports remain ignored because they are dependency-owned API.

Validation

  • git diff --check passed.
  • No [sources] or path = ... entries found in docs/QA project files.
  • QA command: timeout 3600 /home/crackauc/.juliaup/bin/julia +1.10 --project=test/qa -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate(); include("test/qa/qa.jl")'
    • Public API documentation passed: 2/2, including rendered docs.
    • Overall QA still failed on the existing JET report for deprecated NaiveIndexHandler; this PR does not mark that broken or change behavior.
  • Docs command: timeout 3600 /home/crackauc/.juliaup/bin/julia +1.10 --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate(); include("docs/make.jl")' passed with only the local deploy warning and dependency iscall warning.
  • Root-manifest package test command failed before tests because checked-in Manifest.toml was resolved with Julia 1.12.5 and Julia 1.10 could not locate JuliaSyntaxHighlighting.
  • Fresh Julia 1.10 package test command: timeout 3600 /home/crackauc/.juliaup/bin/julia +1.10 -e 'using Pkg; Pkg.activate(; temp=true); Pkg.develop(PackageSpec(path=pwd())); Pkg.test("FiniteStateProjection")' passed:
    • Core/birthdeath2D.jl: 18/18
    • Core/feedbackloop.jl: 12/12
    • Core/telegraph.jl: 17/17
  • Runic v1.7.0 Runic.main(["--check", "."]) passed.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
@ChrisRackauckas
ChrisRackauckas marked this pull request as ready for review July 21, 2026 15:42
@ChrisRackauckas
ChrisRackauckas merged commit 95a22f5 into SciML:main Jul 21, 2026
10 checks passed
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.

2 participants