Skip to content

docs: document public tree and iterator interfaces - #241

Merged
ChrisRackauckas merged 2 commits into
SciML:mainfrom
ChrisRackauckas-Claude:codex/rootedtrees-public-interface-docs
Aug 16, 2026
Merged

ChrisRackauckas merged 2 commits into
SciML:mainfrom
ChrisRackauckas-Claude:codex/rootedtrees-public-interface-docs

Conversation

@ChrisRackauckas-Claude

@ChrisRackauckas-Claude ChrisRackauckas-Claude commented Aug 15, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Add definition-point SciMLStyle documentation for the exported tree, iterator, invariant, partition, representation, and time-integration APIs.
  • Document the supported tree and iterator contracts in docs/src/developer_interfaces.md, including the deliberate SubtreeIterator limitation and mutable-buffer ownership rules.
  • Add generic consumer tests for rooted and bicolored trees and an export-wide definition-point documentation check.

This is a focused docs/interface follow-up to #240. It does not change compat metadata, runtime implementations, or the existing QA exception for the extension-local _distinguishable_colors hook. Please ignore this draft until reviewed by @ChrisRackauckas.

Verification

  • Runic check: passed for all tracked Julia files.
  • typos: passed on changed files.
  • git diff --check: passed.
  • Generic interface tests: iterator 37/37, tree 15/15, exported-doc check 1/1.
  • GROUP=QA julia --startup-file=no --project=. -e 'using Pkg; Pkg.test()': QA/qa.jl 21/21.
  • GROUP=Core julia --startup-file=no --project=. -e 'using Pkg; Pkg.test()': Core interfaces 53/53, order conditions 166/166, rooted-tree tests 8590/8590; the existing colored-tree suite reports 571975 passes and 6 pre-existing broken tests.
  • Local-source docs build with Pkg.develop(Pkg.PackageSpec(path=pwd())): passed through doctests, cross-references, checks, and HTML rendering.
  • Exported binding scan: 37 exports, 0 undocumented.
  • The six existing colored-tree broken tests are unchanged and are not suppressed by this PR.

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 August 16, 2026 01:50
@ChrisRackauckas
ChrisRackauckas merged commit d9522b5 into SciML:main Aug 16, 2026
10 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