mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
Replace uses of shorthand codeblock syntax to avoid issues with localization
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).
This commit is contained in:
@@ -80,7 +80,9 @@ To build an iOS plugin:
|
||||
|
||||
- The configuration file extension must be ``gdip`` (e.g.: ``MyPlugin.gdip``).
|
||||
|
||||
- The configuration file format is as follow::
|
||||
- The configuration file format is as follow:
|
||||
|
||||
::
|
||||
|
||||
[config]
|
||||
name="MyPlugin"
|
||||
|
||||
Reference in New Issue
Block a user