Revision 3603605a doc/devnotes.rst
b/doc/devnotes.rst | ||
---|---|---|
36 | 36 |
- `HsColour <http://hackage.haskell.org/package/hscolour>`_, again |
37 | 37 |
used for documentation (it's source-code pretty-printing) |
38 | 38 |
- `hlint <http://community.haskell.org/~ndm/hlint/>`_, a source code |
39 |
linter (equivalent to pylint for Python) |
|
39 |
linter (equivalent to pylint for Python), recommended version 1.8 or |
|
40 |
above (tested with 1.8.15) |
|
40 | 41 |
- the `QuickCheck <http://hackage.haskell.org/package/QuickCheck>`_ |
41 | 42 |
library, version 2.x |
42 | 43 |
- ``hpc``, which comes with the compiler, so you should already have |
... | ... | |
69 | 70 |
|
70 | 71 |
make hlint |
71 | 72 |
|
72 |
This is not enabled by default as it gets many false positives, and
|
|
73 |
thus the normal output is not “clean”. The above command will generate
|
|
74 |
both output on the terminal and also a HTML report at
|
|
73 |
This is not enabled by default (as the htools component is
|
|
74 |
optional). The above command will generate both output on the terminal
|
|
75 |
and, if any warnings are found, also an HTML report at
|
|
75 | 76 |
``doc/hs-lint.html``. |
76 | 77 |
|
77 | 78 |
When writing or debugging TemplateHaskell code, it's useful to see |
Also available in: Unified diff