Module Dunolinter.Enforce_resultSource

A type to describe the result of an attempt to enforce a predicate during linting.

Sourcetype t =
  1. | Ok
    (*

    The enforcement of the predicate was successful, or perhaps the required condition was already verified without requiring to perform any change.

    *)
  2. | Fail
    (*

    The enforcement of such predicate cannot succeed and requires the user's intervention.

    *)
  3. | Eval
    (*

    This is a special value that instructs the call site to check with eval whether the required condition holds. If the evaluation returns True, the end result is the same as for an Ok status. If the evaluation returns False, this will result in a Fail. If the evaluation is Undefined, this results in an Unapplicable status.

    *)
  4. | 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.

    *)