Document errors and warnings better #6426
Conversation
|
|
@Supriya-48 Thanks for making a start on this and for opening a pull request. I hope to make time later today to look at it. |
There was a problem hiding this comment.
@Supriya-48 Thanks again for starting this. It'll be helpful for our users.
I've built on top of what you started, expanding and restructuring it.
| ## Unknown rule error | ||
|
|
||
| There is an unknown rule in the [configuration object](configure.md). | ||
|
|
||
| You should: | ||
|
|
||
| - install the latest version of Stylelint (`npm i --save-dev stylelint`), as we may have recently added the rule |
There was a problem hiding this comment.
[Note] Judging by the historical issues raised, it's usually an outdated version of Stylelint causing this error and the invalid option warning.
| The chosen [PostCSS syntax](usage/options.md#customsyntax) was unable to parse the source. | ||
| The CSS parser built into Stylelint, or the chosen [custom syntax](usage/options.md#customsyntax), could not parse your code. | ||
|
|
||
| ### Unclosed block |
There was a problem hiding this comment.
[Note] The CSSSyntaxError includes a message, e.g. this demo. I've used those messages as heading within this section so that:
- they're easier to search for
- we can give specific advice on how to resolve the issue
jeddy3
changed the title
There was a problem hiding this comment.
@Supriya-48 @jeddy3 This change is a significant improvement with user-friendly examples! 👏🏼
Co-authored-by: Richard Hallows <jeddy3@users.noreply.github.com>
Closes #4585
e.g. "No, it's self-explanatory."