[TASK] Write dashes as dashes - #586
Merged
Merged
Conversation
Six sentences in this guide separated a parenthesis with "--". The rendering passes that through: on docs.typo3.org the commit message page reads "the type of change -- `[TASK]`", with two hyphens. The habit comes from Sphinx, whose smartquotes setting is on by default and whose default action "qDe" educates quotes, dashes and ellipses, so there "--" becomes an en dash. This rendering has no such transform. They now use the em dash the guide uses elsewhere, and the page on special characters says so, with a link to the Sphinx setting for anyone who wonders why the habit exists. Assisted-by: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: Lina Wolf
linawolf
force-pushed
the
task/use-real-dashes
branch
from
September 26, 2026 10:36
91e0ef8 to
060b53d
Compare
froemken
reviewed
Sep 26, 2026
froemken
approved these changes
Sep 26, 2026
froemken
left a comment
froemken
left a comment
Contributor
There was a problem hiding this comment.
Hi @linawolf,
Thank you for your contribution and for clarifying the typography background.
The explanation regarding the difference in behavior between Sphinx and render-guides is precise and helpful for documentation authors. The markup adheres to all reST standards, the anchor is placed cleanly, and the local rendering succeeds without warnings.
Thank you again for your initiative and contribution!
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
2 participants
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.
Six sentences in this guide separated a parenthesis with "--". The
rendering passes that through: on docs.typo3.org the commit message
page reads "the type of change --
[TASK]", with two hyphens. Thehabit comes from Sphinx, whose smartquotes setting is on by default and
whose default action "qDe" educates quotes, dashes and ellipses, so
there "--" becomes an en dash. This rendering has no such transform.
They now use the em dash the guide uses elsewhere, and the page on
special characters says so, with a link to the Sphinx setting for
anyone who wonders why the habit exists.
Assisted-by: Claude Opus 5 noreply@anthropic.com
Signed-off-by: Lina Wolf