Documentation

Failure description, with suggestions if applicable.

Examples for each specific failure case are given below.

Unrecognized failure case, with suggestions if applicable.

>>> let names = Short 'i' :| [Short 'a', Short 'b', Long "abode"]
>>> let opts = $$(precompile $ none .> Option names (plain [|| id ||]))
>>> putDocW 80 $ failure opts $ Unrecognized "abid" (Long "abid")
invalid option '--abid'; perhaps you meant any of '-a', '-b', '-i' or '--abode'?

Unsaturated failure case.

>>> unsaturated (Long 'foo')
option '--foo' requires an argument

Oversaturated failure case.

>>> oversaturated "foo"
option '--foo' doesn't allow an argument
>>> oversaturated ""
end of options delimiter '--' doesn't allow an argument