package dunolint
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=e4ca7c98db73dd9ab2ae8cba37ee0645f580267484e9893dbce6e28f4f2f0170
sha512=7ca658fb96139a0c41724355ac6aaf83d75468c7df14569b8f6090711f73a8fb2408ed1145384e756418682f0fa660a915842fd2b3f8b42e5ed4990e795b384e
doc/dunolint.dunolinter/Dunolinter/Enforce_result/index.html
Module Dunolinter.Enforce_result
Source
A type to describe the result of an attempt to enforce a predicate during linting.
type t =
| Ok
(*The enforcement of the predicate was successful, or perhaps the required condition was already verified without requiring to perform any change.
*)| Fail
(*The enforcement of such predicate cannot succeed and requires the user's intervention.
*)| Eval
(*This is a special value that instructs the call site to check with
*)eval
whether the required condition holds. If the evaluation returnsTrue
, the end result is the same as for anOk
status. If the evaluation returnsFalse
, this will result in aFail
. If the evaluation isUndefined
, this results in anUnapplicable
status.| Unapplicable
(*The predicate in question does not apply to the stanza currently at hand. For example, it starts with a selector that does not match the stanza being linted. Unapplicable predicates are ignored by dunolint.
*)