Skip to content

Document exported public API#627

Draft
ChrisRackauckas-Claude wants to merge 1 commit into
SciML:masterfrom
ChrisRackauckas-Claude:agent/public-doc-coverage
Draft

Document exported public API#627
ChrisRackauckas-Claude wants to merge 1 commit into
SciML:masterfrom
ChrisRackauckas-Claude:agent/public-doc-coverage

Conversation

@ChrisRackauckas-Claude

Copy link
Copy Markdown
Contributor

This PR should be ignored until reviewed by @ChrisRackauckas.

Summary

  • Adds source-site docstrings for exported RecursiveArrayTools names that were missing them.
  • Adds rendered @docs entries for exported main-package utilities, plotting helpers, convenience constructor types, and ragged-array subpackage exports.
  • Updates the docs environment to load the local RecursiveArrayToolsRaggedArrays subpackage.
  • Adds QA coverage that scans export, Julia public, @public, and SciMLPublic-style markings and verifies both source docstrings and rendered docs entries.

Validation

  • julia -e 'import Runic; exit(Runic.main(["--check", "src/vector_of_array.jl", "src/utils.jl", "test/QA/qa.jl", "docs/make.jl"]))'
  • timeout 3600 env JULIA_DEPOT_PATH=/home/crackauc/sandbox/tmp_20260708_051717_3275/.julia_depot_rat julia --project=test/QA test/QA/qa.jl
  • timeout 3600 env JULIA_DEPOT_PATH=/home/crackauc/sandbox/tmp_20260708_051717_3275/.julia_depot_rat julia --project=docs docs/make.jl

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
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