ilyakooo0/ormolu
1
0
Fork 0
mirror of https://github.com/ilyakooo0/ormolu.git synced 2024-09-11 16:36:31 +03:00
Code Issues Projects Releases Wiki Activity

Update the readme mentioning current limitations

Browse Source 
[skip ci]
This commit is contained in:
mrkkrp 2019-08-28 15:01:58 +02:00
parent 376d8ed9b0
commit 6713073c5e
No known key found for this signature in database
GPG Key ID: 8564658B2889FF7C
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -64,6 +64,15 @@ formatted output.
$ ormolu --mode inplace Module.hs
```
## Current limitations
* Does not handle CPP (wontfix, see [the design document][design]).
* Ormolu knows nothing about operator precedence so complex chains of
operators may be rendered in slightly unpleasant ways †.
* Various minor idempotence issues, most of them are related to comments †.
† To be resolved in 0.0.2.0.
## Editor integration
We know of the following editor integrations:
@ -94,6 +103,7 @@ See [LICENSE.md](./LICENSE.md).
Copyright © 2018–present Tweag I/O
[design]: ./DESIGN.md#cpp
[haskell-src-exts]: https://hackage.haskell.org/package/haskell-src-exts
[hindent]: https://hackage.haskell.org/package/hindent
[emacs-package]: https://github.com/vyorkin/ormolu.el