Date: Mon, 21 Jan 2019 20:20:27 -0700 Subject: fix a doc typo --- docs/disml/Disml/Sharder/Shard/index.html | 2 +- docs/disml/Disml__Sharder/Shard/index.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/disml/Disml/Sharder/Shard/index.html b/docs/disml/Disml/Sharder/Shard/index.html index 3ae7f28..5c68419 100644 --- a/docs/disml/Disml/Sharder/Shard/index.html +++ b/docs/disml/Disml/Sharder/Shard/index.html @@ -1,2 +1,2 @@ -Shard (disml.Disml.Sharder.Shard)

Module `Sharder.Shard`

Module representing a single shard.

type shard = { hb_interval : Core.Time.Span.t Async.Ivar.t; Time span between heartbeats, wrapped in an Ivar. seq : int; Current sequence number session : string option; Session id, if one exists. pipe : Websocket_async.Frame.t Async.Pipe.Reader.t * Websocket_async.Frame.t Async.Pipe.Writer.t; Raw frame IO pipe used for websocket communications. ready : unit Async.Ivar.t; A simple Ivar indicating if the shard has received READY. url : string; The websocket URL in use. id : int * int; A tuple as expected by Discord. First element is the current shard index, second element is the total shard count. }

Representation of the state of a shard.

Wrapper around an internal state, used to wrap shard.

type 'a t = { mutable state : 'a; }: Wrapper around an internal state, used to wrap shard.

val heartbeat : shard -> shard Async.Deferred.t: Send a heartbeat to Discord. This is handled automatically.

val set_status : status:Yojson.Safe.json -> shard -> shard Async.Deferred.t: Set the status of the shard.

val request_guild_members : ?⁠query:string -> ?⁠limit:int -> guild:Snowflake.t -> shard -> shard Async.Deferred.t: Request guild members for the shard's guild. Causes dispatch of multiple member chunk events.

val create : url:string -> shards:(int * int) -> unit -> shard Async.Deferred.t: Create a new shard

\ No newline at end of file +Shard (disml.Disml.Sharder.Shard)

Module `Sharder.Shard`

Module representing a single shard.

type shard = { hb_interval : Core.Time.Span.t Async.Ivar.t; Time span between heartbeats, wrapped in an Ivar. seq : int; Current sequence number session : string option; Session id, if one exists. pipe : Websocket_async.Frame.t Async.Pipe.Reader.t * Websocket_async.Frame.t Async.Pipe.Writer.t; Raw frame IO pipe used for websocket communications. ready : unit Async.Ivar.t; A simple Ivar indicating if the shard has received READY. url : string; The websocket URL in use. id : int * int; A tuple as expected by Discord. First element is the current shard index, second element is the total shard count. }: Representation of the state of a shard.

type 'a t = { mutable state : 'a; }: Wrapper around an internal state, used to wrap shard.

val heartbeat : shard -> shard Async.Deferred.t: Send a heartbeat to Discord. This is handled automatically.

val set_status : status:Yojson.Safe.json -> shard -> shard Async.Deferred.t: Set the status of the shard.

val request_guild_members : ?⁠query:string -> ?⁠limit:int -> guild:Snowflake.t -> shard -> shard Async.Deferred.t: Request guild members for the shard's guild. Causes dispatch of multiple member chunk events.

val create : url:string -> shards:(int * int) -> unit -> shard Async.Deferred.t: Create a new shard

\ No newline at end of file diff --git a/docs/disml/Disml__Sharder/Shard/index.html b/docs/disml/Disml__Sharder/Shard/index.html index e75a3f8..dd012b2 100644 --- a/docs/disml/Disml__Sharder/Shard/index.html +++ b/docs/disml/Disml__Sharder/Shard/index.html @@ -1,2 +1,2 @@ -Shard (disml.Disml__Sharder.Shard)

Module `Disml__Sharder.Shard`

Module representing a single shard.

Representation of the state of a shard.

Wrapper around an internal state, used to wrap shard.

type 'a t = { mutable state : 'a; }: Wrapper around an internal state, used to wrap shard.

val heartbeat : shard -> shard Async.Deferred.t: Send a heartbeat to Discord. This is handled automatically.

val set_status : status:Yojson.Safe.json -> shard -> shard Async.Deferred.t: Set the status of the shard.

val request_guild_members : ?⁠query:string -> ?⁠limit:int -> guild:Disml.Snowflake.t -> shard -> shard Async.Deferred.t: Request guild members for the shard's guild. Causes dispatch of multiple member chunk events.

val create : url:string -> shards:(int * int) -> unit -> shard Async.Deferred.t: Create a new shard

\ No newline at end of file +Shard (disml.Disml__Sharder.Shard)

Module `Disml__Sharder.Shard`

Module representing a single shard.

type shard = { hb_interval : Core.Time.Span.t Async.Ivar.t; Time span between heartbeats, wrapped in an Ivar. seq : int; Current sequence number session : string option; Session id, if one exists. pipe : Websocket_async.Frame.t Async.Pipe.Reader.t * Websocket_async.Frame.t Async.Pipe.Writer.t; Raw frame IO pipe used for websocket communications. ready : unit Async.Ivar.t; A simple Ivar indicating if the shard has received READY. url : string; The websocket URL in use. id : int * int; A tuple as expected by Discord. First element is the current shard index, second element is the total shard count. }: Representation of the state of a shard.

type 'a t = { mutable state : 'a; }: Wrapper around an internal state, used to wrap shard.

val heartbeat : shard -> shard Async.Deferred.t: Send a heartbeat to Discord. This is handled automatically.

val set_status : status:Yojson.Safe.json -> shard -> shard Async.Deferred.t: Set the status of the shard.

val request_guild_members : ?⁠query:string -> ?⁠limit:int -> guild:Disml.Snowflake.t -> shard -> shard Async.Deferred.t: Request guild members for the shard's guild. Causes dispatch of multiple member chunk events.

val create : url:string -> shards:(int * int) -> unit -> shard Async.Deferred.t: Create a new shard

\ No newline at end of file -- cgit v1.2.3

`hb_interval : Core.Time.Span.t Async.Ivar.t;`	Time span between heartbeats, wrapped in an Ivar.
`seq : int;`	Current sequence number
`session : string option;`	Session id, if one exists.
`pipe : Websocket_async.Frame.t Async.Pipe.Reader.t * Websocket_async.Frame.t Async.Pipe.Writer.t;`	Raw frame IO pipe used for websocket communications.
`ready : unit Async.Ivar.t;`	A simple Ivar indicating if the shard has received READY.
`url : string;`	The websocket URL in use.
`id : int * int;`	A tuple as expected by Discord. First element is the current shard index, second element is the total shard count.