From 7bf6bf48e180312f237013cedc14b2ac988bfd9d Mon Sep 17 00:00:00 2001 From: Aaron Weiss Date: Thu, 21 May 2015 14:29:54 -0400 Subject: [PATCH] Enhanced documentation for user tracking API. --- src/client/server/mod.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/client/server/mod.rs b/src/client/server/mod.rs index 330fcab..3750b31 100644 --- a/src/client/server/mod.rs +++ b/src/client/server/mod.rs @@ -26,7 +26,8 @@ pub trait Server<'a, T, U> { /// Gets an Iterator over Commands received by this Server. fn iter_cmd(&'a self) -> ServerCmdIterator<'a, T, U>; /// Gets a list of Users in the specified channel. This will be none if the channel is not - /// being tracked, or if tracking is not supported altogether. + /// being tracked, or if tracking is not supported altogether. For best results, be sure to + /// request `multi-prefix` support from the server. fn list_users(&self, channel: &str) -> Option>; }