package core

  1. Overview
  2. Docs
package core
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t = {
  1. summary : Base.string;
  2. readme : Base.string Base.option;
  3. anons : Anons.t;
  4. flags : Flag_info.t Base.list;
}
include Ppx_compare_lib.Comparable.S with type t := t
val compare : t Base__Ppx_compare_lib.compare
val flags : t -> Flag_info.t Base.list
val anons : t -> Anons.t
val readme : t -> Base.string Base.option
val summary : t -> Base.string
val sexp_of_t : t -> Sexplib0.Sexp.t
val find_flag : t -> Base.string -> Flag_info.t Base.Or_error.t

find_flag t prefix looks up the flag, if any, to which prefix refers.

It raises if prefix does not begin with - as all flags should.

find_flag does not consider aliases_excluded_from_help, and it assumes that all flags can be passed by prefix. These are limitations in the underlying shape representation.

val get_usage : t -> Base.string
val t_of_sexp : Base.Sexp.t -> t
  • deprecated [since 2020-04] Use [Command.Stable.Shape.Base_info].
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct