Skip to content

Enforce strict callback documentation - #330

Merged
ChrisRackauckas merged 2 commits into
SciML:masterfrom
ChrisRackauckas-Claude:agent/strict-docstrings-followup
Jul 30, 2026
Merged

ChrisRackauckas merged 2 commits into
SciML:masterfrom
ChrisRackauckas-Claude:agent/strict-docstrings-followup

Conversation

@ChrisRackauckas-Claude

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

Copy link
Copy Markdown
Member

Summary

  • enable default Documenter doctests and missing-public-doc enforcement
  • make affected public callback docstrings definition-point, SciMLStyle-compliant API references
  • document exact positional arguments, keywords, return values, failure modes, and examples

Local verification

  • julia +1.12 --project=docs docs/make.jl
  • GROUP=QA julia +1.12 --project=. -e 'using Pkg; Pkg.test()'
  • julia +1.12 --project=. -e 'using Pkg; Pkg.test()'
  • Runic and git diff --check

Ignore until reviewed by @ChrisRackauckas.

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 30, 2026 10:03
@ChrisRackauckas
ChrisRackauckas merged commit c8a16d2 into SciML:master Jul 30, 2026
18 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