Adrien/flycheck-vale
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated README to reflect new "enabled" toggle.

Browse Source
This commit is contained in:
Austin Bingham
2017-05-16 15:31:21 +02:00
parent b6eafed59c
commit 0b88d6e0af
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -15,3 +15,14 @@ To use `flycheck-vale` just `require` it and run `flycheck-vale-setup`:
(require 'flycheck-vale)
(flycheck-vale-setup)
```
## Dis/enabling flycheck vale for specific buffers
The buffer-local variable `flycheck-vale-enabled` allows you to enabled or
disable vale linting for specific buffers. If this variable is `t` then vale
linting will be performed (assuming you've got `flycheck-mode` enabled, etc.)
Likewise, if it is `nil` then vale linting will never be performed.
You can use `flycheck-vale-toggle-enabled` to toggle this variable between `t`
and `nil`. (And of course you can set it other ways if you want.) By default the
variable is `t`.