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/user/user_t.mli | |
| parent | Fix Message.t.mentions (diff) | |
| download | disml-f43c41dcf56a30f3fac0de07349b2c505203c380.tar.xz disml-f43c41dcf56a30f3fac0de07349b2c505203c380.zip | |
Add more docs
Diffstat (limited to 'lib/models/user/user_t.mli')
| -rw-r--r-- | lib/models/user/user_t.mli | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/lib/models/user/user_t.mli b/lib/models/user/user_t.mli index b0228f9..694fc1e 100644 --- a/lib/models/user/user_t.mli +++ b/lib/models/user/user_t.mli @@ -1,11 +1,13 @@ +(** A partial user. Used internally. *) type partial_user = { id: User_id_t.t; } [@@deriving sexp, yojson] +(** A user object. *) type t = { - id: User_id_t.t; - username: string; - discriminator: string; - avatar: string option; - bot: bool; + id: User_id_t.t; (** The user's Snowflake ID, wrapped in the convenience [`User_id] type. *) + username: string; (** The username of the user. *) + discriminator: string; (** The 4 digits, as a string, that come after the '#' in a Discord username. *) + avatar: string option; (** The hash of the user avatar, if they have one set. See {!User.face} to get the avatar URL. *) + bot: bool; (** Whether the user is a bot. *) } [@@deriving sexp, yojson]
\ No newline at end of file |