Docs: Modify policy to not translate command-line help

This commit is contained in:
Chun Kuan Lee 2018-07-04 09:18:29 +08:00 committed by GitHub
parent 686e97a0c7
commit 747ee89b4c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -21,21 +21,11 @@ On a high level, these strings are to be translated:
- GUI strings, anything that appears in a dialog or window - GUI strings, anything that appears in a dialog or window
- Command-line option documentation
### GUI strings ### GUI strings
Anything that appears to the user in the GUI is to be translated. This includes labels, menu items, button texts, tooltips and window titles. Anything that appears to the user in the GUI is to be translated. This includes labels, menu items, button texts, tooltips and window titles.
This includes messages passed to the GUI through the UI interface through `InitMessage`, `ThreadSafeMessageBox` or `ShowProgress`. This includes messages passed to the GUI through the UI interface through `InitMessage`, `ThreadSafeMessageBox` or `ShowProgress`.
### Command-line options
Documentation for the command line options in the output of `--help` should be translated as well.
Make sure that default values do not end up in the string, but use string formatting like `strprintf(_("Threshold for disconnecting misbehaving peers (default: %u)"), 100)`. Putting default values in strings has led to accidental translations in the past, and forces the string to be retranslated every time the value changes.
Do not translate messages that are only shown to developers, such as those that only appear when `--help-debug` is used.
General recommendations General recommendations
------------------------ ------------------------