Skip to content

Conversation

@fingolfin
Copy link
Member

@fingolfin fingolfin commented Oct 28, 2025

In Markdown, links are written as [desc](URL), and no space is allowed between ] and (. However, Julia's Markdown parser explicitly accepted it (not clear why).

This may break links in a few package manuals, but the fix will be easy in each case (just remove the extra spaces).

But being more consistent with most (all??) other Markdown implementations seems more important to me; it is very surprising when one copies basic Markdown that works fine elsewhere into a Julia package manual and it suddenly is treated completely differently.

Resolves JuliaDocs/Documenter.jl#2538
Resolves JuliaDocs/Documenter.jl#2681

In Markdown, links are written as `[desc](URL)`, and no
space is allowed between `]` and `(`. However, Julia's
Markdown parser explicitly accepted it (not clear why).

This may break links in a few package manuals, but the fix
will be easy in each case (just remove the extra spaces).

But being more consistent with most (all??) other Markdown
implementations seems more important to me; it is very
surprising when one copies basic Markdown that works fine
elsewhere into a Julia package manual and it suddenly is
treated completely differently.

Resolves JuliaDocs/Documenter.jl#2681
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Incorrectly interpreting square brackets in docstrings as links Docs erroneously parse a phrase [something] (something else) as markdown link

2 participants