Created
August 29, 2019 18:56
-
-
Save ahal/6104bd5a2d110438c23ee32f3f610e44 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
diff --git a/tools/lint/docs/usage.rst b/tools/lint/docs/usage.rst | |
--- a/tools/lint/docs/usage.rst | |
+++ b/tools/lint/docs/usage.rst | |
@@ -1,14 +1,28 @@ | |
Running Linters Locally | |
======================= | |
Using the Command Line | |
---------------------- | |
+.. mermaid:: | |
+ | |
+ sequenceDiagram | |
+ participant Alice | |
+ participant Bob | |
+ Alice->John: Hello John, how are you? | |
+ loop Healthcheck | |
+ John->John: Fight against hypochondria | |
+ end | |
+ Note right of John: Rational thoughts <br/>prevail... | |
+ John-->Alice: Great! | |
+ John->Bob: How about you? | |
+ Bob-->John: Jolly good! | |
+ | |
You can run all the various linters in the tree using the ``mach lint`` command. Simply pass in the | |
directory or file you wish to lint (defaults to current working directory): | |
.. parsed-literal:: | |
./mach lint path/to/files | |
Multiple paths are allowed: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment