Skip to content

Strengthen public API documentation QA - #640

Merged
ChrisRackauckas merged 1 commit into
SciML:masterfrom
ChrisRackauckas-Claude:agent/recursivearraytools-narrow-v24-20260808
Aug 8, 2026
Merged

Strengthen public API documentation QA#640
ChrisRackauckas merged 1 commit into
SciML:masterfrom
ChrisRackauckas-Claude:agent/recursivearraytools-narrow-v24-20260808

Conversation

@ChrisRackauckas-Claude

Copy link
Copy Markdown
Member

Ignore this PR until it has been reviewed by @ChrisRackauckas.

Summary

  • require SciMLTesting 2.4+ in the root and every subpackage QA environment, remove redundant 2.4-default settings and TOML source paths, and retain only issue-linked or package-specific exceptions
  • replace whole-module imports with explicit imports so strict ExplicitImports QA passes without a generic exception
  • give package-owned public APIs definition-site SciMLStyle docstrings, render the root module and developer interfaces, and enable strict doctests and exported-binding checks in Documenter
  • add focused tests for documented constructors, recursive-array utilities, and the plotting developer interface

The ragged-array JET exception remains narrowly version-gated and tracked by #620. The root Aqua ambiguity exception remains tracked by #326.

Validation

Local checks passed with SciMLTesting 2.6.2 (satisfying the new 2.4 minimum):

  • Julia 1.12.6 (+release): root package tests, all three subpackage test suites, root QA, all three subpackage QA suites, strict docs/doctests/rendered-doc checks, and Runic
  • Julia 1.10.11 (+1.10): root package tests, all three subpackage test suites, root QA, all three subpackage QA suites, strict docs/doctests/rendered-doc checks, and Runic

Existing issue-linked expected failures remain: root Aqua ambiguities (#326), ragged JET on Julia 1.11+ (#620), and two pre-existing broken ragged/core indexing assertions. No tests were skipped, disabled, or relaxed.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
@ChrisRackauckas
ChrisRackauckas marked this pull request as ready for review August 8, 2026 18:37
@ChrisRackauckas
ChrisRackauckas merged commit 550bd20 into SciML:master Aug 8, 2026
47 of 54 checks passed

Copy link
Copy Markdown
Member Author

Repository-owned CI checks are green. The broad integration failures also occur with clean RecursiveArrayTools master 88fc415 and were reproduced locally in isolated worktrees, so I have kept those unrelated repairs out of this documentation/QA PR:

No test was skipped, silenced, or loosened.

@ChrisRackauckas-Claude

Copy link
Copy Markdown
Member Author

Follow-up after completing the remaining clean-base downstream reproductions:

Together with the earlier clean-base findings (#3942, #4075, #4178, and SciMLSensitivity #1587), these establish that the remaining integration failures are dependency-owner regressions rather than changes introduced by this documentation/QA PR. All repository-owned RecursiveArrayTools checks were green before merge.

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