-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Use single/double quotes consistently #94
Comments
A PR would be appreciated. Also we should add a linter rule for it. |
Tagging @wanderer06 because he asked on Gitter. It was used in the same example because the point was that you can use either type of string literal. If you see other locations, we'll take a PR, but I'm going to close this unless you've found others. |
I'd say it depends on the level of consistency you'd like to achieve. Generally the quoting style is consistent within an example, but not across multiple chunks of code. One example I can think of is the Writing declaration files page, where it uses single quotes in one example:
But switches to double just down below:
Then there are cases where using a string literal in code description seems at random:
Sometimes a return value, type or variable will be quoted in some comments, but not in others:
Down below:
Or
There are cases where
Interfaces.md includes some reversed quotes:
Should the docs use single or double quotes consistently throughout all examples? What about getting started file examples?
|
In code samples
Outside of code samples
|
This was to basically indicate that "padding" is a kind of wishy-washy term, and other uses of "padding" refer to the parameter name. |
The Handbook currently uses both single and double quotes, sometimes even in the same example:
Settling on just one style would look better.
The text was updated successfully, but these errors were encountered: