Replace uses of shorthand codeblock syntax to avoid issues with localization #10969
+580
−200
Conversation
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
|
It would be nice to restrict the usage of this feature at the CI level. I don't know if there is such an option in the reStructuredText linter. But even if not, we could use a simple Python script or Linux utility to search for the sequence |
Mickeon
reviewed
May 28, 2025
…ization Previously, many paragraphs in the documentation used `::` at the end of a line as a replacement for a single colon (and `::` on the following line). Due to this, the `::` was part of the extracted string for localization. Weblate also showed a warning about the trailing `::`, as it's not normally expected to be there. This change requires translators to revalidate all modified strings. However, considering many of those have broken code blocks due to translators replacing `::` with `:`, it can be a good idea. This also adds documentation writing guidelines for code blocks and admonitions. This commit does not modify existing admonitions in any way (as this would lead to a much larger diff, and require more localizable text to be revalidated by translators).
Calinou
force-pushed
the
code-block-avoid-shorthand-syntax
branch
from
d19d020 to
8a6ad4c
Compare
Mickeon
approved these changes
May 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Previously, many paragraphs in the documentation used
::at the end of a line as a replacement for a single colon (and::on the following line). Due to this, the::was part of the extracted string for localization. Weblate also showed a warning about the trailing::, as it's not normally expected to be there.This change requires translators to revalidate all modified strings. However, considering many of those have broken code blocks due to translators replacing
::with:, it can be a good idea.This also adds documentation writing guidelines for code blocks and admonitions. This commit does not modify existing admonitions in any way (as this would lead to a much larger diff, and require more localizable text to be revalidated by translators).