docs: include SciMLProblemReservoir docstrings in the manual#457
Merged
ChrisRackauckas merged 1 commit intoJun 20, 2026
Conversation
The Documentation build was failing with Documenter's missing_docs check: the continuous-time reservoir types in src/layers/sciml_reservoir.jl (AbstractSciMLProblemReservoir, SciMLProblemReservoir, AbstractSampler, TerminalStateSampling) are exported and carry docstrings but were not referenced in any @docs block. Add a 'Continuous-time reservoirs' section to the Layers API page so the four docstrings are included in the manual, clearing the missing_docs error that terminated makedocs. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Saswatsusmoy
added a commit
to Saswatsusmoy/ReservoirComputing.jl
that referenced
this pull request
Jun 22, 2026
Master picked up an out-of-band PR SciML#457 that added @docs entries for the four SciMLProblemReservoir / AbstractSampler / TerminalStateSampling types to docs/src/api/layers.md while this PR was in review. Those docstrings were also added by this PR's own 'Continuous-Time Reservoirs' section (in the location Francesco asked for, after Wrappers), so the auto-merge left two @docs blocks declaring the same four symbols and Documenter rejected the build with 'duplicate docs found'. Resolution: drop master's section (which sat between ESN and Wrappers), keep this PR's section (after Wrappers, before Cellular Automata) per Francesco's 2026-06-14 placement request. Net effect: one Continuous-Time Reservoirs section, in the agreed location, single @docs block. Other master changes that came in cleanly: toepliz topology init (PR SciML#443), GPU.yml workflow tweak, actions/checkout v7 bump.
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
2 participants
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.
The master Documentation CI check is failing. Documenter's
missing_docscheck terminatesmakedocsbecause four exported, docstring-carrying types insrc/layers/sciml_reservoir.jlare not referenced in any@docs/@autodocsblock:ReservoirComputing.AbstractSciMLProblemReservoirReservoirComputing.SciMLProblemReservoirReservoirComputing.AbstractSamplerReservoirComputing.TerminalStateSamplingFix
Add a "Continuous-time reservoirs" section to
docs/src/api/layers.md(these are Lux layer / sampler types, so the Layers API page is the natural home) that includes the four docstrings.Local verification
Built the docs locally on Julia 1.12.6 (the CI
1channel) withjulia --project=docs docs/make.jl:CheckDocument: running document checks.now passes (nomissing_docserror)RenderDocument/HTMLWritercomplete; build exits 0docs/build/api/layers/index.htmlOnly remaining log lines are benign warnings that predate this change (models page over the 100 KiB
size_threshold_warn, well under the 200 KiB hard limit; "Skipping deployment" which is expected for a local run).Please ignore until reviewed by @ChrisRackauckas