]> jfr.im git - irc/xchat.git/commitdiff
Fix some documentation
authorlsitu <redacted>
Sat, 23 Jan 2010 01:07:40 +0000 (01:07 +0000)
committerlsitu <redacted>
Sat, 23 Jan 2010 01:07:40 +0000 (01:07 +0000)
git-svn-id: svn://svn.code.sf.net/p/xchat/svn@1389 893a96be-7f27-4fdf-9d1e-6aeec9d3cce1

plugins/perl/Xchat.pod

index bf58eae97ef20a872265e7b8c57cfe744d213520..e9cceb38c545e693e46ff5f5ddb524b169c9a3ed 100644 (file)
@@ -1152,9 +1152,11 @@ C<$nick> -  the nick to look for, if this is not given your own nick will be
 
 This function is mainly intended to be used as a shortcut for when you need
 to retrieve some information about only one user in a channel. Otherwise it
-is to use L<get_list|xchat_get_list>.
+is better to use L<get_list|xchat_get_list>.
 If C<$nick> is found a hash reference containing the same keys as those in the
 "users" list of L<get_list|xchat_get_list> is returned otherwise undef is returned.
+Since it relies on L<get_list|xchat_get_list> this function can only be used in a
+channel context.
 
 =head3 C<Xchat::context_info( [$context] )>