Skip to content

Document ComplementaritySolve public API#75

Merged
ChrisRackauckas merged 4 commits into
SciML:mainfrom
ChrisRackauckas-Claude:agent/document-public-api
Jul 21, 2026
Merged

Document ComplementaritySolve public API#75
ChrisRackauckas merged 4 commits into
SciML:mainfrom
ChrisRackauckas-Claude:agent/document-public-api

Conversation

@ChrisRackauckas-Claude

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

Copy link
Copy Markdown
Member

Ignore until reviewed by @ChrisRackauckas.

Summary

  • Adds SciMLStyle docstrings and rendered documentation for ComplementaritySolve-owned exported problem, algorithm, sensitivity, system, alias, and solution APIs.
  • Pins the registered SciMLTesting test compat to exactly "2.4" without changing its UUID or adding a path/source override.
  • Uses SciMLTesting 2.4 defaults for rendered-doc and explicit-import checks.
  • Preserves the existing CommonSolve solve reexport with fixed reexports_allow = (:solve,) and excludes only that dependency-owned name from local rendered docs.
  • Uses a normal definition-site docstring for LinearComplementaritySystem and removes the obsolete Markdown import and dependency; no public API changed.

Validation

  • timeout 3600 env TESTING_GROUP=QA BACKEND_GROUP=CPU /home/crackauc/.juliaup/bin/julia +release --project=. -e "using Pkg; Pkg.resolve(); Pkg.test(; coverage=false)"
    • Registry test sandbox resolved SciMLTesting v2.4.0.
    • Complementarity Solve | 13 pass | 13 total | 1m06.6s; exit code 0.
  • timeout 3600 /home/crackauc/.juliaup/bin/julia +release --project=. -e "using Pkg; Pkg.test(; coverage=false)"
    • Complementarity Solve | 266 pass | 7 broken | 273 total | 27m37.6s; exit code 0.
  • timeout 3600 /home/crackauc/.juliaup/bin/julia +release --project=/home/crackauc/sandbox/tmp_20260708_051717_3275/.runic_env -m Runic --check src test docs/make.jl
    • Runic v1.7.0; exit code 0.
  • git diff --check
  • Source/PR audit found no remaining @doc, doc""", @doc_str, or Markdown source references.

No [sources], package path entries, absolute paths, temporary files, or generated manifests are included.

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 21, 2026 14:02
@ChrisRackauckas
ChrisRackauckas merged commit c6df3b4 into SciML:main Jul 21, 2026
11 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