Skip to content

Commit

Permalink
Update doc of abandon_yielded_and_paused
Browse files Browse the repository at this point in the history
  • Loading branch information
raphael-proust committed Jul 28, 2023
1 parent d192120 commit e4a74cc
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions src/unix/lwt_main.mli
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,7 @@ val abandon_yielded_and_paused : unit -> unit [@@deprecated "Use Lwt.abandon_pau
(** Causes promises created with {!Lwt.pause} and {!Lwt_main.yield} to remain
forever pending.
[yield] is now deprecated in favor of the more general {!Lwt.pause}.
Once [yield] is phased out, this function will be deprecated as well.
(Note that [yield] is deprecated in favor of the more general {!Lwt.pause}.)
This is meant for use with {!Lwt_unix.fork}, as a way to “abandon” more
promise chains that are pending in your process.
Expand Down

0 comments on commit e4a74cc

Please sign in to comment.