Document DEQs public alias#225
Merged
ChrisRackauckas merged 1 commit intoJul 10, 2026
Merged
Conversation
Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR completes the public API documentation audit for the exported
DEQsmodule alias. It adds a source docstring at the alias definition and keeps the rendered API-page coverage for the alias.Documenter currently canonicalizes module-valued alias doc objects to the aliased module during
missing_docs, so@docs DeepEquilibriumNetworks.DEQscannot satisfy theDeepEquilibriumNetworks.DEQsbinding. The docs build now drops that single alias binding from Documenter metadata and relies on the existing API prose for rendered docs coverage.Ignore this PR until it has been reviewed by @ChrisRackauckas.
Validation
git diff --checksrc/DeepEquilibriumNetworks.jlanddocs/make.jlDEQs,DeepEquilibriumNetwork,DeepEquilibriumSolution,MultiScaleDeepEquilibriumNetwork,MultiScaleNeuralODE,MultiScaleSkipDeepEquilibriumNetwork,SkipDeepEquilibriumNetwork; result: no undocumented exportsjulia +1.10 --project=docs -e 'using Pkg; Pkg.instantiate(); include("docs/make.jl")'passed locally. It emitted existing warnings for arXiv HTTP redirects, a large generated tutorial page, and skipped deployment outside CI.\n-Pkg.test()was attempted and fails before layer assertions becauseOrdinaryDiffEqfails to precompile:OrdinaryDiffEqBDFcannot importOrdinaryDiffEqCore.find_algebraic_vars_eqs. The same failure reproduces on cleanorigin/mainatad4f946, so it is pre-existing and tracked in Pkg.test fails to precompile OrdinaryDiffEq on main #224.