Expand i18n coverage to all relevant strings #1370
Merged
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
per1234
added
type: enhancement
silvanocerza
reviewed
Aug 5, 2021
silvanocerza
reviewed
Aug 5, 2021
silvanocerza
reviewed
Aug 5, 2021
silvanocerza
reviewed
Aug 5, 2021
silvanocerza
reviewed
Aug 5, 2021
silvanocerza
reviewed
Aug 5, 2021
| @@ -142,7 +142,7 @@ func identify(pm *packagemanager.PackageManager, port *discovery.Port) ([]*rpc.B | |||
| logrus.Debug("Board not recognized") | |||
| } else if err != nil { | |||
| // this is bad, bail out | |||
| return nil, errors.Wrap(err, "error getting board info from Arduino Cloud") | |||
| return nil, errors.Wrap(err, tr("error getting board info from Arduino Cloud")) | |||
There was a problem hiding this comment.
Should Arduino Cloud be translated? 🤔
There was a problem hiding this comment.
My guess is no, but this might be one of those cases where the loss of context in "error getting board info from %s" makes it more difficult for the translator to interpret the meaning?
I'm not really sure. I am not sufficiently experienced in this area to be able to make judgements at this level.
silvanocerza
reviewed
Aug 5, 2021
silvanocerza
reviewed
Aug 5, 2021
silvanocerza
reviewed
Aug 5, 2021
This provides internationalization of the strings of the Arduino CLI code base. It will now be possible to completely translate the primary Arduino CLI user interface. We decided that the log messages would be excluded from the internationalization scope for now. The reason is that the addition of these strings would significantly increase the workload on the community translators, while generally being of less visibility and/or importance to the users. Even though on an individual basis there are surely specific log messages of higher importance than specific non-log strings that were internationalized, the log/non-log dichotomy provided an objective criterion for determining which strings were in scope for this initial effort. Perhaps we will expand the i18n coverage at some time in the future after there has been good progress on the initial translation effort. Some techniques were employed to facilitate translation: - Code references were moved out of strings in cases where a translator might mistake them for prose and translate them. - Indices were added to printf verbs when multiple were present in a string. This allows the translator to easily insert them at the appropriate location in the sentence structure without being required to understand the Go printf syntax and without being restricted to their relative order in the English language source string. Co-authored-by: Silvano Cerza <[email protected]>
silvanocerza
approved these changes
Aug 5, 2021
5 tasks
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.
Please check if the PR fulfills these requirements
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)Enhancement
Although an effective internationalization (AKA "i18n") framework is already in place in the Arduino CLI code base (#676), the actual coverage of the interface's strings is very minimal, intended only to serve as an initial proof of concept to evaluate the system.
This provides internationalization of the strings of the Arduino CLI code base. It will now be possible to completely
translate the primary Arduino CLI user interface.
titled accordingly?
No breaking change.
Scope
We decided that the log messages would be excluded from the internationalization scope for now. The reason is that the addition of these strings would significantly increase the workload on the community translators, while generally being of less visibility and/or importance to the users. Even though on an individual basis there are surely specific log messages of higher importance than specific non-log strings that were internationalized, the log/non-log dichotomy provided an objective criterion for determining which strings were in scope for this initial effort. Perhaps we will expand the i18n coverage at some time in the future after there has been good progress on the initial translation effort.
Notes
Some techniques were employed to facilitate translation:
printfverbs when multiple were present in a string. This allows the translator to easily insert them at the appropriate location in the sentence structure without being required to understand the Go printf syntax and without being restricted to their relative order in the English language source string.