Skip to content

Add test for 'Unexpected Julia interpolation' warnings #2818

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 7, 2025
Merged

Add test for 'Unexpected Julia interpolation' warnings #2818

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions test/examples/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -614,14 +614,6 @@ Also in block quotes:
> ##### Heading 5
> ###### Heading 6
# JuliaValue
It is possible to create pseudo-interpolations with the `Markdown` parser: $foo.
$([1 2 3; 4 5 6])
They do not get evaluated.
# Admonitions
!!! note "'note' admonition"
Expand Down
33 changes: 33 additions & 0 deletions test/warnings/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,39 @@ julia> WarningTests.run_warnings_test("at-docs")
"""
module AtDocsWarningTests end

@doc raw"""
```jldoctest; setup=:(using ..WarningTests)
julia> WarningTests.run_warnings_test("dollar")
[ Info: SetupBuildDirectory: setting up build directory.
[ Info: Doctest: running doctests.
[ Info: ExpandTemplates: expanding markdown templates.
[ Info: CrossReferences: building cross-references.
[ Info: CheckDocument: running document checks.
[ Info: Populate: populating indices.
[ Info: RenderDocument: rendering document.
[ Info: HTMLWriter: rendering HTML pages.
┌ Warning: Unexpected Julia interpolation in the Markdown. This probably means that you have an
│ unbalanced or un-escaped $ in the text.
│
│ To write the dollar sign, escape it with `\$`
│
│ We don't have the file or line number available, but we got given the value:
│
│ `foo` which is of type `Symbol`
└ @ Documenter
┌ Warning: Unexpected Julia interpolation in the Markdown. This probably means that you have an
│ unbalanced or un-escaped $ in the text.
│
│ To write the dollar sign, escape it with `\$`
│
│ We don't have the file or line number available, but we got given the value:
│
│ `[1 2 3; 4 5 6]` which is of type `Expr`
└ @ Documenter
```
"""
module UnbalancedDollarWarningTests end

fixtests = haskey(ENV, "DOCUMENTER_FIXTESTS")

# run the doctests in Julia >= 1.10 (some outputs have minor difference in
Expand Down
7 changes: 7 additions & 0 deletions test/warnings/src/dollar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# JuliaValue

It is possible to create pseudo-interpolations with the `Markdown` parser: $foo.

$([1 2 3; 4 5 6])

They do not get evaluated.
Loading