Skip to content

Commit 0941a94

Browse files
committed
Improved API documentation
1 parent 11b126a commit 0941a94

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

lib/postgresql.mli

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -745,9 +745,9 @@ object
745745

746746
method connect_poll : polling_status
747747
(** After creating a connection with [~startonly:true], {!connect_poll}
748-
must be called a number of times before the connection can be used. The
749-
precise procedure is described in libpq manual, but the following code
750-
should capture the idea, assuming monadic concurrency primitives
748+
must be called a number of times before the connection can be used.
749+
The precise procedure is described in the libpq manual, but the following
750+
code should capture the idea, assuming monadic concurrency primitives
751751
[return] and [>>=] along with polling functions [wait_for_read] and
752752
[wait_for_write]:
753753
{[
@@ -768,7 +768,7 @@ object
768768
finish re-establishing the connection. *)
769769

770770
method reset_poll : polling_status
771-
(** Used analogously to {!connect_poll} after calling {!reset_start} *)
771+
(** Used analogously to {!connect_poll} after calling {!reset_start}. *)
772772

773773
method set_nonblocking : bool -> unit
774774
(** [set_nonblocking b] sets state of the connection to nonblocking if
@@ -873,7 +873,8 @@ object
873873

874874
method lo_read_ba :
875875
large_object -> ?pos : int -> ?len : int ->
876-
(char, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array1.t -> int
876+
(char, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array1.t ->
877+
int
877878
(** As [lo_read], but performs a zero-copy read into the given Bigarray. *)
878879

879880
method lo_seek : ?pos : int -> ?whence : seek_cmd -> large_object -> unit

0 commit comments

Comments
 (0)