simon/moonpool
1
0
Fork 0
mirror of https://github.com/c-cube/moonpool.git synced 2025-12-06 03:05:30 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
moonpool/either/_doc-dir
History
c-cube 0147032036 deploy: 38df050a13
2024-02-21 02:59:17 +00:00
..
CHANGES.md deploy: 38df050a13 2024-02-21 02:59:17 +00:00
LICENSE deploy: 38df050a13 2024-02-21 02:59:17 +00:00
README.md deploy: 38df050a13 2024-02-21 02:59:17 +00:00

README.md

Compatibility Either module

OCaml-CI Build Status Documentation

Projects that want to use the Either module defined in OCaml 4.12.0 while staying compatible with older versions of OCaml should use this library instead. On OCaml versions 4.12 and above, this library defines an alias Either to the standard library's definition of the module. Otherwise, it provides an equivalent definition of Either.

Depending on this library

Opam libraries depending on this module are encouraged to use a conditional dependency:

depends: [
  ("ocaml" {>= "4.12.0"} | "either")
]

This ensures that any dependencies of your library that don't need pre-4.12 compatibility will never transitively depend on either.

Acknowledgements

This repository structure is mostly copied from JaneStreet/result, which provides a compatibility result type. Thanks to the OCaml maintainers for their improvements to the standard library.