Conversation
github-actions
bot
added
documentation
ddbeck
force-pushed
the
vale-lint
branch
8 times, most recently
from
d75df18 to
5059a5d
Compare
| @@ -1,5 +1,5 @@ | |||
| name: "@charset" | |||
| description: The `@charset` CSS at-rule specifies the character encoding of an external style sheet. | |||
| description: The `@charset` CSS at-rule specifies the character encoding of an external style sheet. | |||
There was a problem hiding this comment.
I changed this file so it would get flagged on review. Before merging, I ought to undo this change, to show I'm just ignoring this suggestion.
| @@ -1,5 +1,5 @@ | |||
| name: <del> | |||
| description: The `<del>` element element represents a range of text that has been deleted from a document, styling text as strikethrough by default. | |||
| description: The `<del>` element element represents a range of text that has been deleted from a document, styling text as strikethrough by default. | |||
There was a problem hiding this comment.
I changed this file so it would get flagged on review. Before merging, I ought to push a change fixing it.
| @@ -1,5 +1,5 @@ | |||
| name: beforeunload | |||
| description: "The `beforeunload` event is fired when the current window is about to be unloaded. Typically this is used to display a dialog to confirm if users really want to leave the page when there is unsaved data that would be lost." | |||
| description: "The `beforeunload` event is fired when the current window is about to be unloaded. Typically you use this to display a dialog to confirm if users really want to leave the page when there is unsaved data that would be lost." | |||
There was a problem hiding this comment.
This (and several other feature changes) fix warnings or errors from Vale.
ddbeck
changed the title
| @@ -1,5 +1,5 @@ | |||
| name: <del> | |||
| description: The `<del>` element element represents a range of text that has been deleted from a document, styling text as strikethrough by default. | |||
| description: The `<del>` element element represents a range of text that has been deleted from a document, styling text as strikethrough by default. | |||
There was a problem hiding this comment.
Philip doesn't like how ugly the vale messages are. I agree—they're ugly! I should see if this has been fixed in a more-recent release.
There was a problem hiding this comment.
The reason these are ugly is because of because of reviewdog, more or less. For some reason the github-pr-annotations reporter includes the Raw Output bit and you can't turn it off.
There exists a reviewdog/reviewdog#2323 discussion and reviewdog/reviewdog#437 issue, but neither seems to have had any action associated with them.
There are other reporters (which might not have this problem), but they won't appear in the GitHub PR review UI (e.g., you'd have to go look specifically at the "Checks" tab, where warnings would go unnoticed).
1 participant
This PR imposes some automatic checks on feature descriptions using Vale.
I've turned on some default rules from Vale (like detecting words
doubleddoubled up) and a couple of rules from our guidelines. There are many other rules we could turn on (such as spelling) if we like this approach.See my self review (and generated comments) to see how this would work in practice.