1
1
mirror of https://github.com/tweag/ormolu.git synced 2024-09-11 21:27:46 +03:00

Update the description of magic comments in the readme

The logic has changed a little.
This commit is contained in:
Mark Karpov 2021-09-14 11:06:58 +02:00
parent db5b92a932
commit a1773e1ccb
No known key found for this signature in database
GPG Key ID: 8564658B2889FF7C

View File

@ -152,9 +152,9 @@ and
This allows us to disable formatting selectively for code between these
markers or disable it for the entire file. To achieve the latter, just put
`{- ORMOLU_DISABLE -}` at the very top. Note that for Ormolu to work the
source code must still be parseable even when the disabled regions are
omitted. Because of that the magic comments cannot be placed arbitrarily,
but rather must enclose independent top-level definitions.
fragments where Ormolu is enabled must be parseable on their own. Because of
that the magic comments cannot be placed arbitrarily, but rather must
enclose independent top-level definitions.
### Account for .cabal files