README: Add installation and linter documentation. #10
Conversation
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
amanagr
force-pushed
the
update_readme
branch
2 times, most recently
from
7e4f6cd to
1dc47ab
Compare
timabbott
reviewed
May 1, 2020
timabbott
reviewed
May 1, 2020
timabbott
reviewed
May 1, 2020
Update documentation on how to use Zulint. Describe RuleList, Rule and how to properly write them. Recommend pip for installation. Explan arguments to external linter and how to add one. Add example output.
amanagr
commented
Apr 29, 2021
|
|
||
| * Add `<YOUR LINTER VARIABLE NAME>.do_lint()` add the end of your lint file. |
There was a problem hiding this comment.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update documentation on how to use zulint. Describe RuleList,
Rule and how to properly write them. Recommend pip to installation.