package dunolint
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=1b064927c9e1ef5352a1886ae34a206fef0ce6a913c19a77b0162acc108e0e50
sha512=6cbc08ba318bef6584d15a4491e3dde1bf436109ce0f8b7c400a9f91bbcee64c5785bc924df11eafe98243ec2f188a7f92c58c5062729f3e2af1e9977f1a5e67
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.
*)