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

Clarify enabling/disabling

This commit is contained in:
tomjaguarpaw 2020-09-17 11:18:08 +01:00 committed by Mark Karpov
parent 139df241fe
commit 6ced0eba7b

View File

@ -114,10 +114,10 @@ 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 the source code should
still be parseable even without the “excluded” part. Because of that the
magic comments cannot be placed arbitrarily, but should rather enclose
independent top-level definitions.
`{- 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.
## Current limitations