Skip to content

Document JumpProcesses public API#615

Merged
ChrisRackauckas merged 5 commits into
SciML:masterfrom
ChrisRackauckas-Claude:docs/public-api-coverage
Jul 12, 2026
Merged

Document JumpProcesses public API#615
ChrisRackauckas merged 5 commits into
SciML:masterfrom
ChrisRackauckas-Claude:docs/public-api-coverage

Conversation

@ChrisRackauckas-Claude

@ChrisRackauckas-Claude ChrisRackauckas-Claude commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

This draft PR should be ignored until reviewed by @ChrisRackauckas.

Summary

  • Adds SciMLStyle-style source docstrings for JumpProcesses-owned public/exported API gaps around pure leaping, RSSA bracketing, aggregator helper predicates, tau-leaping algorithms, variable-rate function-wrapper aggregation, and spatial topology/mass-action APIs.
  • Expands docs/src/api.md so the owned public API is rendered through @docs blocks instead of leaving exported names out of the manual.
  • Adds a focused QA test that checks the curated JumpProcesses-owned public API has both source docstrings and rendered API entries.
  • Preserves the existing source layout; unrelated whole-file formatter changes were removed.

Validation

  • git diff --check upstream/master...HEAD
  • Post-rebase GROUP=QA Pkg.test() passed: QA Tests 14/14.
  • Full curated GROUP=All Pkg.test() passed locally on the cleaned patch.
  • docs/make.jl passed locally with the checkout developed into the docs environment. Documenter reported the existing missing-docstring and large-example warnings, then rendered HTML successfully.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
@ChrisRackauckas ChrisRackauckas marked this pull request as ready for review July 12, 2026 08:42
@ChrisRackauckas ChrisRackauckas merged commit 09f3130 into SciML:master Jul 12, 2026
12 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