Re: [heycam/webidl] Add space to class string of iterator objects (#483)

In general I like referring to properties, methods, and class names without quotes, using `<code>` instead. That's also what's encouraged by Bikeshed's default conventions, e.g. when you do `{{EventTarget}}`, there are no quotes generated in the output. That speaks to examples like

```diff
Note: A leading <span class="char">"_"</span> is used to escape an identifier from looking
-like a reserved word so that, for example, an interface named “interface” can be
-like a reserved word so that, for example, an interface named "<code>interface</code>" can be
defined.  The leading <span class="char">"_"</span> is dropped to unescape the
identifier.
```

which should probably be just `<code>interface</code>`, or

```diff
{{ECMAScript/Set}} objects.  If the <emu-t>readonly</emu-t>
-keyword is used, this includes “entries”, “forEach”, “has”,
-“keys”, “values”, {{@@iterator}} methods and a “size” getter.
-For read–write setlikes, it also includes “add”, “clear”, and “delete” methods.
+keyword is used, this includes "<code>entries</code>", "<code>forEach</code>", "<code>has</code>",
+"<code>keys</code>", "<code>values</code>", {{@@iterator}} methods and a "<code>size</code>" getter.
+For read–write setlikes, it also includes "<code>add</code>", "<code>clear</code>", and "<code>delete</code>" methods.
```

where again the quotes are probably not ideal.

It's less clear what to do when talking about an identifier, or a "name" e.g. as in

```diff
-Although the “toJSON” [=identifier=] is not a [=reserved identifier=],
+Although the "<code>toJSON</code>" [=identifier=] is not a [=reserved identifier=],
```

or

```diff
Interfaces that [=support indexed properties=] must define
-an [=integer types|integer-typed=] [=attribute=] named “length”.
+an [=integer types|integer-typed=] [=attribute=] named "<code>length</code>".
```

Probably identifiers and names are strings? I imagine the line gets blurry sometimes. E.g. if we modified the methods listing above to say "methods named ..." instead of "... methods", we'd need to add quotes everywhere?

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/heycam/webidl/pull/483#issuecomment-349351300