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.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.mli')
| -rw-r--r-- | lib/models/user/user.mli | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/lib/models/user/user.mli b/lib/models/user/user.mli index 6e2c0f1..d6050c2 100644 --- a/lib/models/user/user.mli +++ b/lib/models/user/user.mli @@ -1,6 +1,13 @@ include module type of User_t +(** The user tag. Equivalent to concatenating the username and discriminator, separated by a '#'. *) val tag : t -> string + +(** The mention string for the user. Equivalent to [<@USER_ID>]. *) val mention : t -> string + +(** The default avatar for the user. *) val default_avatar : t -> string + +(** The avatar url of the user, falling back to the default avatar. *) val face : t -> string
\ No newline at end of file |