search

errata-ai / vale

:pencil: A markup-aware linter for prose built with speed and extensibility in mind.
https://vale.sh
MIT License
4.51k stars 155 forks source link

add tag to suppress Vale errors/warnings for specific case #52

Closed FedorRomanov closed 6 years ago

FedorRomanov commented 6 years ago

Some errors/warnings reported by Vale are perfectly valid English prose. Ultimately, Vale just provides suggestions, potential issues and only author should decide if text needs corrections of not. It would be very handy to have an ability to suppress such specific 'style smells' by using special tag, e.g.

<!DOCTYPE html>
<html>
<p>In many cases, ......be returned.<!--novale.begin-->Note that<!--novale.end--> the geocoder is very tolerant...
</html>

When processing the such tag vale should not report an issue:

1:426   warning  Consider removing 'Note that'  vale.Editorializing

Similar tags could be added for other file formats(Java, C, PHP, e.t.c.)

jdkato commented 6 years ago

This is currently available in Markdown, HTML, and reStructuredText (see https://valelint.github.io/docs/config/#using-comments).

refaelsh commented 3 years ago

This is currently available in Markdown, HTML, and reStructuredText (see https://valelint.github.io/docs/config/#using-comments).

The link does not works. I was googling exactly this issue, but the link does not works.

andrewferrier commented 1 year ago

It appears that the documentation has moved here: https://vale.sh/docs/topics/config#markup-based-configuration