Skip to content

Commit

Permalink
More thoroughly mark Lwt_sequence deprecated
Browse files Browse the repository at this point in the history
Lwt.add_task_l and Lwt.add_task_r are also deprecated by this.

Part of #361.
  • Loading branch information
aantron committed Nov 10, 2017
1 parent 6170bc1 commit 53b56c6
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/core/lwt.mli
Original file line number Diff line number Diff line change
Expand Up @@ -1622,6 +1622,9 @@ val waiter_of_wakener : 'a u -> 'a t
(** {3 Linked lists of promises} *)

val add_task_r : ('a u) Lwt_sequence.t -> 'a t
[@@ocaml.deprecated
" Deprecated because Lwt_sequence is an implementation detail of Lwt. See
https://github.com/ocsigen/lwt/issues/361"]
(** [Lwt.add_task_r sequence] is equivalent to
{[
Expand All @@ -1638,6 +1641,9 @@ p
optimization, which may be removed. *)

val add_task_l : ('a u) Lwt_sequence.t -> 'a t
[@@ocaml.deprecated
" Deprecated because Lwt_sequence is an implementation detail of Lwt. See
https://github.com/ocsigen/lwt/issues/361"]
(** Like {!Lwt.add_task_r}, but the equivalent code calls {!Lwt_sequence.add_l}
instead. *)

Expand Down
4 changes: 4 additions & 0 deletions src/core/lwt_sequence.mli
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@
doubly-linked list library as an alternative.
*)

[@@@ocaml.deprecated
" This module is an implementation detail of Lwt. See
https://github.com/ocsigen/lwt/issues/361"]

type 'a t
(** Type of a sequence holding values of type ['a] *)

Expand Down

0 comments on commit 53b56c6

Please sign in to comment.