Skip to content

Commit

Permalink
Rename Irmin.Node.S.effect type to read_effect
Browse files Browse the repository at this point in the history
  • Loading branch information
art-w committed Oct 10, 2024
1 parent 7f2d988 commit aa524cb
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
5 changes: 5 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
- **irmin-git**
- Expose `Content_addressable` type (#2329, @art-w)

### Changed

- **irmin**
- Rename `Node.S.effect` to `read_effect` for OCaml 5.3 compatibility (#2347, @art-w)

### Fixed

- **irmin-client**
Expand Down
4 changes: 2 additions & 2 deletions src/irmin/node_intf.ml
Original file line number Diff line number Diff line change
Expand Up @@ -124,10 +124,10 @@ module type Core = sig
purpose (so [Tree.hash] and [Tree.equal] are not in the Lwt monad as
well). *)

type effect := expected_depth:int -> node_key -> t option
type read_effect := expected_depth:int -> node_key -> t option
(** The type for read effects. *)

val with_handler : (effect -> effect) -> t -> t
val with_handler : (read_effect -> read_effect) -> t -> t
(** [with_handler f] replace the current effect handler [h] by [f h]. [f h]
will be called for all the recursive read effects that are required by
recursive operations on nodes. .*)
Expand Down

0 comments on commit aa524cb

Please sign in to comment.