diff options
| author | Austin Hellyer <[email protected]> | 2016-11-30 07:08:37 -0800 |
|---|---|---|
| committer | Austin Hellyer <[email protected]> | 2016-11-30 07:08:37 -0800 |
| commit | 6adeee1750657043f2ab43fe1bcea83b4dd7fc96 (patch) | |
| tree | c396f20de22636b231a9d18d2bd7cf449632e283 /src/model | |
| parent | Add remaining REST routes (diff) | |
| download | serenity-6adeee1750657043f2ab43fe1bcea83b4dd7fc96.tar.xz serenity-6adeee1750657043f2ab43fe1bcea83b4dd7fc96.zip | |
Clarify some docs
Diffstat (limited to 'src/model')
| -rw-r--r-- | src/model/mod.rs | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/src/model/mod.rs b/src/model/mod.rs index 832cda4..7cb0dfb 100644 --- a/src/model/mod.rs +++ b/src/model/mod.rs @@ -1,3 +1,18 @@ +//! Mappings of objects received from the API, with optional helper methods for +//! ease of use. +//! +//! Models can optionally have additional helper methods compiled, by enabling +//! the `methods` feature. +//! +//! Methods like [`Message::delete`] or [`Webhook::execute`] are provided with +//! this feature, which can be shorthands for operations that are otherwise in +//! the [`Context`], or the much lower-level [`rest`] module. +//! +//! [`Context`]: ../client/struct.Context.html +//! [`Message::delete`]: struct.Message.html#method.delete +//! [`Webhook::execute`]: struct.Webhook.html#method.execute +//! [`rest`]: ../client/rest/index.html + #[macro_use] mod utils; |