Skip to content

Commit

Permalink
Docs: Fix code-blocks in spaced-comment docs
Browse files Browse the repository at this point in the history
The space-comment docs page had indented code blocks with the JSON type. Because
of that they weren't converted to HTML correctly, leaving `json` in plain text
on the page.
  • Loading branch information
mgol committed Nov 2, 2016
1 parent 578c373 commit 524d256
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/rules/spaced-comment.md
Expand Up @@ -26,17 +26,17 @@ The rule takes two options.
* The `"exceptions"` value is an array of string patterns which are considered exceptions to the rule.
Please note that exceptions are ignored if the first argument is `"never"`.

```json
"spaced-comment": ["error", "always", { "exceptions": ["-", "+"] }]
```
```json
"spaced-comment": ["error", "always", { "exceptions": ["-", "+"] }]
```

* The `"markers"` value is an array of string patterns which are considered markers for docblock-style comments,
such as an additional `/`, used to denote documentation read by doxygen, vsdoc, etc. which must have additional characters.
The `"markers"` array will apply regardless of the value of the first argument, e.g. `"always"` or `"never"`.

```json
"spaced-comment": ["error", "always", { "markers": ["/"] }]
```
```json
"spaced-comment": ["error", "always", { "markers": ["/"] }]
```

The difference between a marker and an exception is that a marker only appears at the beginning of the comment whereas
exceptions can occur anywhere in the comment string.
Expand Down

0 comments on commit 524d256

Please sign in to comment.