fix docstring (markdown issue, no review required)#1438
Merged
Conversation
Contributor
|
DynamicPPL.jl documentation for PR #1438 is available at: |
Member
Author
|
I cancelled all CI tests to avoid wasting resources on this. |
shravanngoswamii
added a commit
that referenced
this pull request
Jul 17, 2026
main's Doctests workflow is currently red: https://github.com/TuringLang/DynamicPPL.jl/actions/runs/29509495151/job/87658917625 #1438 fixed a real markdown bug (an unclosed \`\`\` fence in `check_model`'s docstring), which is good, but closing that fence changed where Documenter thinks the `jldoctest` block ends. That exposed a doctest that was already stale: the "Incorrect model" example expected ``` julia> check_model(model; error_on_failure=true) ERROR: varname x used multiple times in model ``` but `check_model`'s actual behavior for repeated `VarName`s (since at least the `DebugAccumulator` rework) is to `@warn` per repeated variable and then raise the generic `error_on_failure` message at `src/debug_utils.jl:265-266`: ``` julia> check_model(model; error_on_failure=true) ┌ Warning: Assigning to the variable x led to a previous value being overwritten. This indicates that a value is being set twice (e.g. if the same variable occurs in a model twice). └ @ DynamicPPL.DebugUtils DynamicPPL.jl/src/debug_utils.jl:237 ERROR: Model check failed; please see the warnings above for details. ``` Updated the docstring to match, mirroring the same warning-block style already used in the "Correct model" example just above it. Verified locally: `GROUP=Doctests julia --project=. -e 'using Pkg; Pkg.test()'` passes (1/1) on Julia 1.12, matching the CI job that was failing.
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
1 participant
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.
No description provided.