diff options
| author | Adelyn Breelove <[email protected]> | 2019-01-28 09:48:49 -0700 |
|---|---|---|
| committer | Adelyn Breelove <[email protected]> | 2019-01-28 09:48:49 -0700 |
| commit | f43c41dcf56a30f3fac0de07349b2c505203c380 (patch) | |
| tree | 2d2e228a2dd1cd489927cfec547494a433bded42 /lib/models/guild/member_t.mli | |
| parent | Fix Message.t.mentions (diff) | |
| download | disml-f43c41dcf56a30f3fac0de07349b2c505203c380.tar.xz disml-f43c41dcf56a30f3fac0de07349b2c505203c380.zip | |
Add more docs
Diffstat (limited to 'lib/models/guild/member_t.mli')
| -rw-r--r-- | lib/models/guild/member_t.mli | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/lib/models/guild/member_t.mli b/lib/models/guild/member_t.mli index 4f39b6c..918885e 100644 --- a/lib/models/guild/member_t.mli +++ b/lib/models/guild/member_t.mli @@ -27,14 +27,15 @@ type member_update = { nick: string option; } [@@deriving sexp, yojson] +(** A member object. *) type t = { - nick: string option; - roles: Role_id.t list; - joined_at: string; - deaf: bool; - mute: bool; - user: User_t.t; - guild_id: Guild_id_t.t; + nick: string option; (** The nickname of the member, if they have one set. *) + roles: Role_id.t list; (** The roles the member has. *) + joined_at: string; (** An ISO8601 timestamp of when the user joined. *) + deaf: bool; (** Whether the user is deafened. *) + mute: bool; (** Whether the user is muted. *) + user: User_t.t; (** The underlying user object for the member. *) + guild_id: Guild_id_t.t; (** The guild ID in which the member exists. *) } [@@deriving sexp, yojson] val wrap : guild_id:Snowflake.t -> member -> t
\ No newline at end of file |