Skip to content
Snippets Groups Projects
Commit dfcd948d authored by Loïc Correnson's avatar Loïc Correnson
Browse files

[server] doc typos

parent 2961997d
No related branches found
No related tags found
No related merge requests found
......@@ -26,7 +26,7 @@
type json = Json.t
val page : Doc.page (** Page for builtin kernel data types *)
val page : Doc.page (** Page for general purpose data types *)
val pretty : Format.formatter -> json -> unit
module type S =
......@@ -196,7 +196,7 @@ sig
The default label is the capitalized name.
The provided value, if any, will be used for decoding json tags.
If would be used also for encoding values to json tags if no [~tag]
function is provided when publishing the dictionnary.
function is provided when publishing the dictionary.
Registered values must be hashable with [Hashtbl.hash] function.
You may register a new tag {i after} the dictionary has been published. *)
......@@ -206,7 +206,7 @@ sig
?value:'a ->
unit -> 'a tag
(** Register a new prefix tag in the dictionnary.
(** Register a new prefix tag in the dictionary.
The default label is the capitalized prefix.
To decoding from json is provided to prefix tags.
Encoding is done by emitting tags with form ['prefix:*'].
......
......@@ -80,10 +80,8 @@ type 'a server
(**
Run a server with the provided low-level network primitives to
actually exchange data.
The function does not return until the server is explicitely
Shutdown. Logs are monitored unless [~logs:false] is specified.
actually exchange data. Logs are monitored unless [~logs:false]
is specified.
Default equality is the standard `(=)` one.
*)
......@@ -94,7 +92,8 @@ val create :
unit -> 'a server
(** Run the server forever.
The function will not return until the server is shut down. *)
The function will {i not} return until the server is actually
shut down. *)
val run : 'a server -> unit
(** Start the server in background.
......
......@@ -98,8 +98,8 @@ val remove : 'a array -> 'a -> unit
(** Get the signal associated with the array *)
val signal : 'a array -> Request.signal
(** Register signals a requests for synchronizing
an array with the client.
(** Register everything necessary to synchronize an array with
the client:
- Signal [<name>.sig] is emitted on array updates;
- GET Request [<name>.fetch] is registered to get updates;
- GET Request [<name>.reload] is registered to trigger a full reload.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment