package core

  1. Overview
  2. Docs

Module Shape.Flag_infoSource

Sourcetype t = {
  1. name : Base.string;
    (*

    See flag_name below.

    *)
  2. doc : Base.string;
  3. aliases : Base.string Base.list;
}
include Ppx_compare_lib.Comparable.S with type t := t
Sourceval compare : t -> t -> int
Sourceval aliases : t -> Base.string Base.list
Sourceval doc : t -> Base.string
Sourceval name : t -> Base.string
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

flag_name infers the string which one would pass on the command line. It is not the same as the raw name field, which additionally encodes num_occurrences and requires_arg (sort of).

Sourceval num_occurrences : t -> Num_occurrences.t Base.Or_error.t
Sourceval requires_arg : t -> Base.bool Base.Or_error.t

requires_arg gives undefined behavior on escape flags. This is a limitation of the underlying shape representation.

Sourceval t_of_sexp : Base.Sexp.t -> t
  • deprecated [since 2020-04] Use [Command.Stable.Shape.Flag_info].