Skip to content
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.

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

format_docstrings break jldoctests #778

Open
storopoli opened this issue Nov 8, 2023 · 1 comment
Open

format_docstrings break jldoctests #778

storopoli opened this issue Nov 8, 2023 · 1 comment
Labels
bug Something isn't working

Comments

@storopoli
Copy link

jldoctests expect an empty line, e.g.:

"""
    fun() = "hello"

\`\`\`jldoctest
julia> fun()
"hello"

\`\`\`
"""
hello() = "hello"

However, upon formatting with format_docstrings = true, JuliaFormatter removes the empty line:

"""
    fun() = "hello"

\`\`\`jldoctest
julia> fun()
"hello"
\`\`\`
"""
hello() = "hello"

This causes the jldoctest to fail.

@domluna
Copy link
Owner

domluna commented Nov 22, 2023

i'm guessing it's a CommonMark.jl issue but i'll verify.

@domluna domluna added the bug Something isn't working label Nov 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants