Repository navigation
Document DEQs through its module binding - #245
Merged
ChrisRackauckas merged 1 commit intoAug 28, 2026
Merged
Conversation
Attach the existing DEQs documentation to the module object so Documenter can account for the canonical module binding while preserving help lookup through the alias. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Co-Authored-By: Codex <noreply@openai.com> Agent-Harness: Codex CLI 0.150.1 Agent-Model: unknown Agent-Session: local session ID 01a0441e-3d2f-7170-ab6e-58ef72975a9f
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.
Important
Ignore this PR until it has been reviewed by @ChrisRackauckas.
What changed and why
DEQsevaluates to the package module. Documenter 1.17 normalizes canonical documentation for module-valued aliases to the module binding, while its missing-docs inventory retains the alias binding, so metadata attached directly toDEQscannot be counted as rendered. This moves the existing docstring to the module value and listsDEQsas a signature; Julia help forDEQsstill resolves to that documentation, and the existing@autodocsblock renders it once.Regression evidence
On clean upstream
a4dc3d31b3ae9cc547081132ed0a109ea710f614, I ran:TMPDIR="$HOME/tmp" timeout 3600 julia +release --project=docs docs/make.jland observed:
With this commit, the same command completed
DoctestandCheckDocumentwithout a missing-docs error. Its final link-check stage then encountered an unrelated transient response from GitHub:An immediate direct request to that URL returned HTTP/2 200. A reduced strict Documenter build using the repository's real API
@docs/@autodocsblocks completed successfully withwarnonly = false.The help/metadata check after the fix reported:
This confirms that
Docs.doc(DeepEquilibriumNetworks), help lookup throughDocs.Binding(DeepEquilibriumNetworks, :DEQs), andDEQs === DeepEquilibriumNetworksall retain the expected behavior without leaving separate alias metadata for Documenter to miscount.Verification
GROUP=Core TMPDIR="$HOME/tmp" timeout 3600 julia +release --project=. -e 'using Pkg; Pkg.test()'GROUP=QA TMPDIR="$HOME/tmp" timeout 3600 julia +release --project=. -e 'using Pkg; Pkg.test()'All three commands exited 0 with no output.
Bisect
The first bad commit is 4e6cbaf, which enabled strict SciMLTesting 2.4 QA and thereby exposed the already-unrenderable alias metadata.
Not verified
The complete docs build did not finish after the unrelated external-link HTTP 429 described above. GPU tests were not run because this change only relocates existing documentation metadata.
🤖 Generated with Codex CLI 0.150.1 (model: unknown; session: local session ID 01a0441e-3d2f-7170-ab6e-58ef72975a9f)