Document public API: add docstrings + docs entries#64
Merged
ChrisRackauckas merged 1 commit intoJul 9, 2026
Conversation
`SteadyState` is exported (public API) but had neither a docstring nor a rendered-docs entry; it only appeared inside method signatures on the Main API page. Add a docstring to the `struct SteadyState end` marker type describing its role as the steady-state dispatch tag, and add a standalone `@docs SteadyState` entry to docs/src/mainapi.md so it is rendered. Verified: package loads, `@doc SteadyState` is non-empty, and the docs build (docs/make.jl, Documenter default checkdocs, no warnonly) completes cleanly with the new entry rendered in mainapi.html. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
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
2 participants
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
SteadyStateis part of the exported public API (export FSPSystem, DefaultIndexHandler, SteadyState) but had neither a docstring nor a rendered-docs entry. It only appeared inside method signatures (::SteadyState) on the Main API and Matrix Conversions pages, never documented in its own right.This PR closes that gap:
struct SteadyState end(src/build_rhs_ss.jl) describing it as the marker/dispatch type that selects the steady-state formulation of the CME (transitions out of the truncated state space dropped to propensity 0), matching the docstring style ofFSPSystemandDefaultIndexHandler. Cross-links the three methods that dispatch on it.SteadyStateentry to the@docsblock indocs/src/mainapi.md(Steady-State Problems section) so it is rendered.The other two exported names (
FSPSystem,DefaultIndexHandler) already have both a docstring and a docs entry — verified by loading the package and checkingBase.Docs.docfor every FSP-owned public name.Validation
FSPSystem,DefaultIndexHandler,SteadyState; onlySteadyStatelacked a docstring onmain.@doc SteadyStateis now non-empty and attaches the new docstring.docs/make.jl(Documenter defaultcheckdocs, nowarnonly): completes cleanly,CheckDocument/CrossReferencespass with no missing-docstring errors, and the renderedmainapi.htmlcontains theSteadyStatedocstring block with anchorid="FiniteStateProjection.SteadyState".Please ignore until reviewed by @ChrisRackauckas.
🤖 Generated with Claude Code