docs: add i18n overview & authoring documentation #9361
Conversation
exterkamp
left a comment
exterkamp
left a comment
There was a problem hiding this comment.
LGTM thanks for reorganizing this stream of conscious into a real README!
patrickhulce
left a comment
patrickhulce
left a comment
There was a problem hiding this comment.
LGTM!
boy do I want a snack now though :)
|
|
||
| # Writing UIStrings with LHL | ||
|
|
||
| ❗TODO(exterkamp): explain all the comments and where they go/what they become. |
There was a problem hiding this comment.
should we leave this out/file issues for them?
There was a problem hiding this comment.
imo I was going to handle that in #9114 once it was reimported 🤷♂️
There was a problem hiding this comment.
should we just block this PR on #9114? The implementation may still change until that lands...
There was a problem hiding this comment.
let's land the doc. 9114 can always adjust anything as need be.
There was a problem hiding this comment.
I'd like to do a review then, please, so I'm not just doing a review of it in #9114 after all
There was a problem hiding this comment.
Ooops. Sorry just saw this right after i merged. Happy to take your review and i'll do whatever followups you're thinking
lighthouse-core/lib/i18n/README.md
Outdated
| * To specify the description, use | ||
| * `@description <description>` | ||
| * To specify an example for an ICU replacement, use | ||
| * `@example {<ICU variable name>} <example for ICU replacement>` |
There was a problem hiding this comment.
are we leaving it at {variableName} replacement example then?
|
|
||
| `{timeInMs, number, milliseconds}` is called _Complex ICU_ since the replacement is for complex numbers and uses the custom formatters in Lighthouse. The supported complex ICU formats are: `milliseconds`, `seconds`, `bytes`, `percent`, and `extendedPercent`. | ||
|
|
||
| These complex ICU formats are automatically given @example values during `yarn i18n`. Therefore, a normal description string can be used: |
Co-Authored-By: Patrick Hulce <[email protected]>
This comment has been minimized.
This comment has been minimized.
Co-Authored-By: Patrick Hulce <[email protected]>
Co-Authored-By: Patrick Hulce <[email protected]>
|
A Googler has manually verified that the CLAs look good. (Googler, please make sure the reason for overriding the CLA status is clearly documented in these comments.) ℹ️ Googlers: Go here for more info. |
5 participants
@exterkamp deserves credit for writing this.
I've just spent some time reorganizing it and editing things.
Figured we'd just land this separate to keep the review separate from shane's great placeholders PR (#9114).