aboutsummaryrefslogtreecommitdiff
path: root/src/framework
diff options
context:
space:
mode:
authoracdenisSK <[email protected]>2017-10-10 20:38:55 +0200
committeracdenisSK <[email protected]>2017-10-10 20:38:55 +0200
commit857294358d5f3029850dc79c174b831c0b0c161c (patch)
tree29be61fc78c7660c220c9a7515fcd2f7a5a888e6 /src/framework
parentVariety of methods to search for `Member`. (#187) (diff)
downloadserenity-857294358d5f3029850dc79c174b831c0b0c161c.tar.xz
serenity-857294358d5f3029850dc79c174b831c0b0c161c.zip
Add some docs to `Args`
Diffstat (limited to 'src/framework')
-rw-r--r--src/framework/standard/args.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/framework/standard/args.rs b/src/framework/standard/args.rs
index c4c60af..d773c6b 100644
--- a/src/framework/standard/args.rs
+++ b/src/framework/standard/args.rs
@@ -53,6 +53,10 @@ impl<E: StdError> fmt::Display for Error<E> {
type Result<T, E> = ::std::result::Result<T, Error<E>>;
+/// A utility struct for handling arguments of a command.
+///
+/// General functionality is done via removing an item, parsing it, then returning it; this however
+/// can be mitigated with the `*_n` methods, which just parse and return.
#[derive(Clone, Debug)]
pub struct Args {
delimiter: String,