docs(i18n): add 'meaning' to i18n README #9787
Conversation
lighthouse-core/lib/i18n/README.md
Outdated
| @@ -202,6 +202,7 @@ CTC is a name that is distinct and identifies this as the Chrome translation for | |||
| "name": { | |||
| "message": "Message text, with optional placeholders.", | |||
| "description": "Translator-aimed description of the message.", | |||
| "meaning": "Description given when a message is duplicated, in order to give context to the message.", | |||
There was a problem hiding this comment.
isn't this just a copy of description for us? seems like this doc is a good place to diverge from the chrome docs if we're doing something different :)
There was a problem hiding this comment.
Yup. Just having a meaning in our spec is the divergence. Should there be more context for it?
There was a problem hiding this comment.
+1 to @patrickhulce's comments, but I'm a little confused by the purpose of this. Without an explanation of what meaning is, having it in the example (especially when the example is already labelled "From the Chrome Docs") doesn't really seem to clarify anything about it. Maybe it needs its own little subsection somewhere in here?
|
| ```json | ||
| { | ||
| "name": { | ||
| "message": "Message text, with optional placeholders.", | ||
| "description": "Translator-aimed description of the message.", | ||
| "meaning": "Description given when a message is duplicated, in order to give context to the message. Lighthouse uses a copy of the description for this.", |
There was a problem hiding this comment.
ha, I guess the example fields documenting themselves works :)
Summary
I noticed, upon reviewing the l10n plan for DevTools, that we never mention our divergence from
message.jsonformat (read: "meanings").