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/role.mli | |
| parent | Fix Message.t.mentions (diff) | |
| download | disml-f43c41dcf56a30f3fac0de07349b2c505203c380.tar.xz disml-f43c41dcf56a30f3fac0de07349b2c505203c380.zip | |
Add more docs
Diffstat (limited to 'lib/models/guild/role.mli')
| -rw-r--r-- | lib/models/guild/role.mli | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/lib/models/guild/role.mli b/lib/models/guild/role.mli index 4c4f2a9..b311a60 100644 --- a/lib/models/guild/role.mli +++ b/lib/models/guild/role.mli @@ -2,10 +2,23 @@ open Async include module type of Role_t -val allow_mention : t -> t Deferred.Or_error.t +(** Deletes the role. This is permanent. *) val delete : t -> unit Deferred.Or_error.t + +(** Edits the role to allow mentions. *) +val allow_mention : t -> t Deferred.Or_error.t + +(** Opposite of {!allow_mention} *) val disallow_mention : t -> t Deferred.Or_error.t + +(** Hoists the role. See {!Role.t.hoist}. *) val hoist : t -> t Deferred.Or_error.t + +(** Opposite of {!hoist}. *) +val unhoist : t -> t Deferred.Or_error.t + +(** Sets the colour of the role. *) val set_colour : colour:int -> t -> t Deferred.Or_error.t + +(** Sets the name of the role. *) val set_name : name:string -> t -> t Deferred.Or_error.t -val unhoist : t -> t Deferred.Or_error.t
\ No newline at end of file |