package ocamlformat

  1. Overview
  2. Docs
package ocamlformat
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Config_option.MakeSource

Parameters

module C : CONFIG

Signature

Sourcetype config = C.config
Sourcetype 'a t
Sourcetype kind =
  1. | Formatting
  2. | Operational
Sourcetype parsed_from = [
  1. | `File of Ocamlformat_stdlib.Fpath.t * Ocamlformat_stdlib.int
  2. | `Attribute
]
Sourcetype updated_from = [
  1. | `Env
  2. | `Commandline
  3. | `Parsed of parsed_from
]
Sourcetype deprecated
Sourcetype removed
Sourcetype status = [
  1. | `Valid
  2. | `Deprecated of deprecated
  3. | `Removed of removed
]
Sourcetype '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
Sourcemodule Value : sig ... end
Sourcemodule Value_removed : sig ... end
Sourceval any : 'a Ocamlformat_stdlib.Cmdliner.Arg.conv -> default:'a -> docv:Ocamlformat_stdlib.string -> 'a option_decl

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

Sourceval default : 'a t -> 'a
Sourceval update_using_cmdline : config -> config
Sourceval update : config:config -> from:updated_from -> name:Ocamlformat_stdlib.string -> value:Ocamlformat_stdlib.string -> inline:Ocamlformat_stdlib.bool -> (config, Error.t) Ocamlformat_stdlib.Result.t
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