Skip to content

mdBook smart punctuation is harmful to inline code snippets #1867

Open
@fmease

Description

@fmease

#1516 enabled mdBook smart punctuation. However, this feature also affects inline code snippets as used in EBNF sections for example thereby altering their actual meaning!

See https://doc.rust-lang.org/nightly/reference/items/functions.html#r-items.fn.syntax where mdBook renders ellipses (U+2026) for varargs instead of the intended triple dot ... (3× U+002E).


I don't know of a way to disable 'smart' punctuation on a case by case basis and — taking a step back — I don't know why mdBook applies it to inline code blocks in the first place (there's no upstream issue I could find).

Even if you decide it to be a mdBook issue, this issue should stay open until The Reference is fixed. Right now, the grammar as written is incorrect.

Metadata

Metadata

Assignees

No one assigned

    Labels

    C-bugIncorrect statements, terminology, or rendering issues

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions