Add tags for buffer-local variants of each linter option

1 files changed, 12 insertions, 6 deletions

diff --git a/doc/ale-sh.txt b/doc/ale-sh.txt
index a7f7800e..b35d6f2e 100644
--- a/doc/ale-sh.txt
+++ b/doc/ale-sh.txt
@@ -6,7 +6,7 @@ ALE Shell Integration                                          *ale-sh-options*
 shell                                                            *ale-sh-shell*
 
 g:ale_linters_sh_shell_default_shell     *g:ale_linters_sh_shell_default_shell*
-
+                                         *b:ale_linters_sh_shell_default_shell*
   Type: |String|
   Default: The current shell (`$SHELL`) or `'bash'` if that cannot be read.
 
@@ -20,7 +20,7 @@ g:ale_linters_sh_shell_default_shell     *g:ale_linters_sh_shell_default_shell*
 shellcheck                                                  *ale-sh-shellcheck*
 
 g:ale_sh_shellcheck_executable                 *g:ale_sh_shellcheck_executable*
-
+                                               *b:ale_sh_shellcheck_executable*
   Type: |String|
   Default: `'shellcheck'`
 
@@ -28,7 +28,7 @@ g:ale_sh_shellcheck_executable                 *g:ale_sh_shellcheck_executable*
 
 
 g:ale_sh_shellcheck_options                       *g:ale_sh_shellcheck_options*
-
+                                                  *b:ale_sh_shellcheck_options*
   Type: |String|
   Default: `''`
 
@@ -37,18 +37,24 @@ g:ale_sh_shellcheck_options                       *g:ale_sh_shellcheck_options*
 
   For example, if we want shellcheck to follow external sources (`see SC1091`)
   we can set the variable as such:
-
+>
   let g:ale_sh_shellcheck_options = '-x'
-
+<
 
 g:ale_linters_sh_shellcheck_exclusions *g:ale_linters_sh_shellcheck_exclusions*
-
+                                       *b:ale_linters_sh_shellcheck_exclusions*
   Type: |String|
   Default: `''`
 
   Set this variable to exclude test(s) for shellcheck (-e/--exclude option).
   To exclude more than one option, separate them with commas.
 
+  For example, to ignore some warnings that aren't applicable to files that
+  will be sourced by other scripts, use the buffer-local variant:
+>
+    autocmd BufEnter PKGBUILD,.env
+    \   let b:ale_sh_shellcheck_exclusions = 'SC2034,SC2154,SC2164'
+<
 
 -------------------------------------------------------------------------------
   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: