[i18n-activity] Emphasize locale-neutrality in enum examples (#1470)

aphillips has just created a new issue for https://github.com/w3c/i18n-activity:

== Emphasize locale-neutrality in enum examples ==
Example 39: Sample of a DataSchema serialization

"properties": {
    "status": {
        "title": "Status",
        "type": "string",
        "enum": ["On", "Off", "Error"]

There is nothing wrong with the above example, although it may not be obvious that the string values are not meant to be shown to the end-user as display strings. When writing enums like this, it is commonly an I18N best practice to emphasize that the string values are not meant to be displayed by rendering them "code-like", e.g. `ON` and `OFF` or (less usable) `OnValue` or `off_value`. Consider modifying examples such as the above appropriately.


This follows the process at https://w3c.github.io/i18n-activity/guidelines/review-instructions.html

1. Create the review comment you want to propose by replacing the prompts above these instructions, but **LEAVE ALL THE INSTRUCTIONS INTACT** Then ask the i18n WG to review your comment.

2. Set a label to identify the spec: this starts with s: followed by the spec's short name. If you are unable to do that, ask a W3C staff contact to help.

3. After discussion with the i18n WG, raise an issue in the repository of the WG that owns the spec. Use the text above these instructions as the starting point for that comment, but add any suggestions that arose from the i18n WG. In the other WG's repo, add an 'i18n-needs-resolution' label to the new issue. If you think any of the participants in layout requirements task force groups would be interested in following the discussion, add also the appropriate i18n-\*lreq label(s).

4. Replace the text 'url_for_the_issue_raised' below with a link to the issue you raised in the other WG's repository. Do NOT remove the initial '§ '. Do NOT use []() notation - just paste the URL.

5. Remove the 'pending' label, and add a 'needs-resolution' tag to this tracker issue. If you added an \*lreq label, add the label 'spec-type-issue' and a label to indicate the relevant typographic feature(s), eg. 'i:line_breaking'. The latter represent categories related to the Language Enablement Index, and all start with i:.

6. Edit this issue to **REMOVE ALL THE INSTRUCTIONS**, ie. the two lines that are '---' and all the text between.

End of instructions.

**This is a tracker issue.** Only discuss things here if they are i18n WG internal meta-discussions about the issue. **Contribute to the actual discussion at the following link:**

§ url_for_the_issue_raised

Please view or discuss this issue at https://github.com/w3c/i18n-activity/issues/1470 using your GitHub account

Sent via github-notify-ml as configured in https://github.com/w3c/github-notify-ml-config

Received on Thursday, 10 February 2022 19:08:17 UTC