Skip to content

Document LineSearch public APIs#75

Merged
ChrisRackauckas merged 1 commit into
SciML:mainfrom
ChrisRackauckas-Claude:agent/public-api-docs-linesearch
Jul 10, 2026
Merged

Document LineSearch public APIs#75
ChrisRackauckas merged 1 commit into
SciML:mainfrom
ChrisRackauckas-Claude:agent/public-api-docs-linesearch

Conversation

@ChrisRackauckas-Claude

Copy link
Copy Markdown
Member

This PR should be ignored until reviewed by @ChrisRackauckas.

Summary

  • add source docstrings/examples for exported line-search algorithms and LineSearchSolution
  • add missing exported APIs to the rendered native API page
  • add a focused QA guard for exported API docstrings and docs-page entries
  • remove the missing-docs warn-only setting now that exports are covered

Validation

  • git diff --check
  • timeout 3600 /home/crackauc/.juliaup/bin/julia +release --startup-file=no --project=. -e 'using Pkg; Pkg.instantiate(); Pkg.test()'
  • timeout 3600 /home/crackauc/.juliaup/bin/julia +release --startup-file=no --project=test/qa -e 'using Pkg; Pkg.instantiate(); include("test/qa/qa.jl")'
  • timeout 3600 /home/crackauc/.juliaup/bin/julia +release --startup-file=no --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate(); include("docs/make.jl")'
  • timeout 3600 /home/crackauc/.juliaup/bin/julia +release --startup-file=no --project=. -e 'using Pkg; Pkg.instantiate(); using Runic; exit(Runic.main(["--check", "."]))'

Co-Authored-By: Chris Rackauckas <[email protected]>
@ChrisRackauckas
ChrisRackauckas marked this pull request as ready for review July 10, 2026 19:01
@ChrisRackauckas
ChrisRackauckas merged commit 6117f12 into SciML:main Jul 10, 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