Should string values values in JavaScript be documented with quotes in reference.

[hamishwillee]

The API reference documents string values inconsistently, with quote around the strings, and without. What do people prefer?

Note:

• The templates don't say which is preferred
• My sense is that far mor cases omit the strings.
• Some prefer with the quotes, as it is immediately obvious they are strings
• Others don't, because what else could they be in the given context, especially after you just said? Extra key presses are annoying.

No quotes

An {{jsxref("Array")}} of strings representing blah.
Values may include:

• someValue
  • : The blah blah
• anotherValue
  • : The blah blah

With quotes

An {{jsxref("Array")}} of strings representing blah.
Values may include:

• "someValue"
  • : The blah blah
• "anotherValue"
  • : The blah blah

[Josh-Cena]

If "I prefer no rule as in the status quo and let me decide based on context" is an opinion you are willing to hear, then let that be it; otherwise I prefer quotes to none, because if we ever have non-string values like null, false, or 1, we don't get any ambiguity. This seems to be the current majority of cases in JS docs.

[OnkarRuikar]

+1 to having something to distinguish between strings and other values. A glance tells you it's a string; you don't have to look around.

Our code formatter uses ", so the same should be used for regular and definition lists. We need to convert single quotes to double quotes for consistency:

• https://github.com/mdn/content/blob/main/files/en-us/web/api/contactsmanager/getproperties/index.md?plain=1#L34-L38
• https://github.com/mdn/content/blob/main/files/en-us/web/api/serviceworkercontainer/register/index.md?plain=1#L59-L76
• ...