CONTRIBUTING: describe hlint and how it's used #6840
Merged
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
alerque
suggested changes
Nov 16, 2020
CONTRIBUTING.md
Outdated
Comment on lines
212
to
217
| Pandoc uses [hlint] to identify opportunities for code improvements, | ||
| like redundant brackets, or pointing out unnecessary `Language` | ||
| extensions. However, there sometimes are cases where there are good | ||
| reasons to use code different from what hlint proposes. In these | ||
| cases, the respective warning should be disabled in file | ||
| `.hlint.yaml`. |
There was a problem hiding this comment.
Suggested change
| Pandoc uses [hlint] to identify opportunities for code improvements, | |
| like redundant brackets, or pointing out unnecessary `Language` | |
| extensions. However, there sometimes are cases where there are good | |
| reasons to use code different from what hlint proposes. In these | |
| cases, the respective warning should be disabled in file | |
| `.hlint.yaml`. | |
| Pandoc uses [hlint] to identify opportunities for code improvements | |
| like redundant brackets or unnecessary `Language` | |
| extensions. However, sometimes there are cases where there are good | |
| reasons to use code different from what hlint proposes. In these | |
| cases, the respective warning should be disabled in the file | |
| `.hlint.yaml`. |
CONTRIBUTING.md
Outdated
| A good way to ensure no new hints are triggered is to use a git | ||
| [pre-commit hook], which runs hlint on all updated Haskell files |
There was a problem hiding this comment.
Suggested change
| A good way to ensure no new hints are triggered is to use a git | |
| [pre-commit hook], which runs hlint on all updated Haskell files | |
| A good way to ensure no new warnings are introduced is to use a Git | |
| [pre-commit hook] which runs hlint on all updated Haskell files |
tarleb
force-pushed
the
document-hlint
branch
from
3292025 to
a3aba9b
Compare
alerque
approved these changes
Nov 16, 2020
tarleb
force-pushed
the
document-hlint
branch
from
a3aba9b to
095ef29
Compare
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.
No description provided.