From ca13bee6d650427be536a44b5cd82dad2a014ff2 Mon Sep 17 00:00:00 2001 From: Vidar Holen Date: Tue, 28 Aug 2018 21:00:23 -0700 Subject: [PATCH] Created Checks (markdown) --- Checks.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 Checks.md diff --git a/Checks.md b/Checks.md new file mode 100644 index 0000000..5af831b --- /dev/null +++ b/Checks.md @@ -0,0 +1,10 @@ +## Finding documentation for a check + +Each individual ShellCheck issue has its own wiki page, like these: [[SC1000]], [[SC1001]], ..., [[SC2236]]. + +GitHub Wiki does not support enumerating them on a page, so to find the one you're interested in, you can do any of the following: +* Use the "> Pages" menu on the right (desktop) or below (mobile) and search for the error code, e.g. [[SC2086]]. +* Visit an [arbitrary issue](SC2086) and edit the URL in your browser. +* Trigger the issue on [shellcheck.net](https://www.shellcheck.net) and click/tap the issue id. + +A few older issues may still be missing a wiki page. If you find one, [file an issue](https://github.com/koalaman/shellcheck/issues) and we'll be happy to add it.