package ocamlformat

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module C : CONFIG

Signature

type config = C.config
type 'a t
type kind =
  1. | Formatting
  2. | Operational
type parsed_from = [
  1. | `File of Ocamlformat_stdlib.Fpath.t * Ocamlformat_stdlib.int
  2. | `Attribute
]
type updated_from = [
  1. | `Env
  2. | `Commandline
  3. | `Parsed of parsed_from
]
type deprecated
type removed
type status = [
  1. | `Valid
  2. | `Deprecated of deprecated
  3. | `Removed of removed
]
type 'a option_decl = names:Ocamlformat_stdlib.string Ocamlformat_stdlib.list -> doc:Ocamlformat_stdlib.string -> kind:kind -> ?allow_inline:Ocamlformat_stdlib.bool -> ?status:[ `Valid | `Deprecated of deprecated ] -> (config -> 'a -> config) -> (config -> 'a) -> 'a t
val section_name : kind -> status -> Ocamlformat_stdlib.string
val deprecated : since:Version.t -> Ocamlformat_stdlib.string -> deprecated
val removed : since:Version.t -> Ocamlformat_stdlib.string -> removed
module Value : sig ... end
module Value_removed : sig ... end

Declare an option as removed. Using such an option will result in an helpful error including msg and since.

val default : 'a t -> 'a
val update_using_cmdline : config -> config
val print_config : config -> Ocamlformat_stdlib.unit