[docs] add localization doc #462
Merged
Conversation
This file contains 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
|
We should add a link to this in the contributor guidelines. |
vicroms
approved these changes
Mar 28, 2022
BillyONeal
reviewed
Mar 28, 2022
BillyONeal
reviewed
Mar 28, 2022
BillyONeal
reviewed
Mar 29, 2022
vicroms
approved these changes
Mar 29, 2022
Comment on lines
+31
to
+37
| The comment is used to give context to the translator as to what a placeholder will be replaced with. | ||
| For example, in `BuildResultSummaryHeader` (`"SUMMARY FOR {triplet}"`), | ||
| it will note that an example of `{triplet}` is `'x64-windows'`. | ||
| Most message placeholders (see `messages.h` for the full list - search for `DECLARE_MSG_ARG`) have comments associated with them already. | ||
| Only general placeholders like `{value}`, `{expected}`, and `{actual}` don't have comments associated with them. | ||
| If you use any of these placeholders, write `example of {<name>} is '<expected-value>'` for each of those placeholders, | ||
| separated by `\n`. You can also add context if you feel it's necessary as the first line. |
There was a problem hiding this comment.
This part is a bit hard to follow. Maybe we should start with an example of an existing message that uses all parameters and break down each part of the declaration.
BillyONeal
reviewed
Mar 29, 2022
|
@vicroms I don't know where to link in contributor guidelines; we probably need to rewrite those a bit |
vicroms
requested changes
Mar 30, 2022
Co-authored-by: Victor Romero <romerosanchezv@gmail.com>
vicroms
approved these changes
Mar 31, 2022
BillyONeal
reviewed
Mar 31, 2022
|
|
||
| ### Putting it All Together | ||
|
|
||
| Let's create a vcpkg hello world command to show off how one can use the messages API. |
There was a problem hiding this comment.
I'm still not a fan of including a real example with a lot of code that's likely to rot rather than just linking to a real use but not over my dead body.
BillyONeal
approved these changes
Mar 31, 2022
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.
No description provided.