Documentation: `of_string` returns `Result.result` · anil.recoil.org/unpac-unpac@d730b20

anil.recoil.org / unpac-unpac

fork atom

The unpac monorepo manager self-hosting as a monorepo using unpac

fork atom

Documentation: `of_string` returns `Result.result`

authored by

Raphaël Proust and committed by

Daniel Bünzli 9 years ago d730b202 2f3c4016

+2 -2

1 changed file

expand all

unified split

src

fpath.mli

+2 -2

src/fpath.mli

··· 343 343 be safely converted back with {!v}. *) 344 344 345 345 val of_string : string -> (t, [`Msg of string]) Result.result 346 - (** [of_string s] is the string [s] as a path. [None] is returned if 346 + (** [of_string s] is the string [s] as a path. [Result.Error] is returned if 347 347 {ul 348 348 {- [s] or the path following the {{!split_volume}volume} is empty ([""]), 349 349 except on Windows UNC paths, see below.} ··· 358 358 {- On Windows empty absolute UNC paths are completed to 359 359 their root. For example ["\\\\server\\share"] becomes 360 360 ["\\\\server\\share\\"], 361 - but incomplete UNC volumes like ["\\\\a"] return [None].}} *) 361 + but incomplete UNC volumes like ["\\\\a"] return [Result.Error].}} *) 362 362 363 363 val pp : Format.formatter -> t -> unit 364 364 (** [pp ppf p] prints path [p] on [ppf] using {!to_string}. *)