mirror of
https://github.com/google/comprehensive-rust.git
synced 2025-01-24 06:16:27 +02:00
Remove hints about preserving reference links (#1138)
With mdbook-i18n-helpers 0.2, reference links are automatically turned into inline links in the PO files. This means that translators no longer have to deal with link references in one message and link definitions in another.
This commit is contained in:
parent
63ca76ac3c
commit
6827f62151
11
STYLE.md
11
STYLE.md
@ -80,14 +80,9 @@ When translating the course, please take the following into account:
|
||||
[translated into your language](https://doc.rust-lang.org/book/appendix-06-translation.html),
|
||||
please use the same vocabulary.
|
||||
|
||||
- Be careful to preserve the Markdown syntax of the original text. Pay special
|
||||
attention to reference links in all their variations: `[foo][bar]`, `[foo][]`
|
||||
(which means `[foo][foo]`), and `[foo]` (which also means `[foo][foo]`).
|
||||
|
||||
As an example, if you translate `[foo]`, to `[FOO]`, you must also update the
|
||||
corresponding link definition from `[foo]: https://example.net` to
|
||||
`[FOO]: https://example.net`. If you forget to do this, you end up with a
|
||||
broken link in the translation.
|
||||
- The text you write is in Markdown format. Make sure to preserve the original
|
||||
formatting in the translation by marking text as `` `code` ``, `_emphasis_`
|
||||
and `**strong emphasis**` like in the original.
|
||||
|
||||
- If you find mistakes or things that sound awkward in the original English
|
||||
text, please submit PRs to fix them! Fixing typos in the translation is great,
|
||||
|
Loading…
x
Reference in New Issue
Block a user