Permalink
Browse files

Clarify chanlist Tcl command documentation. Fixes #78

* Clarify chanlist functionality in tcl-commands.doc
* Clarify difference between & and |.
  • Loading branch information...
vanosg committed Nov 14, 2017
1 parent 5d9da79 commit c399e677a99d769a24c48d3403072a194f37de38
Showing with 5 additions and 3 deletions.
  1. +5 −3 doc/sphinx_source/mainDocs/tcl-commands.rst
@@ -1165,10 +1165,10 @@ onchansplit <nick> [channel]
Module: irc
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
chanlist <channel> [flags[&chanflags]]
chanlist <channel> [flags][<&|>chanflags]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Description: flags are any global flags; the '&' denotes to look for channel specific flags. Examples:
Description: flags are any global flags; the '&' or '|' denotes to look for channel specific flags, where '&' will return users having ALL chanflags and '|' returns users having ANY of the chanflags. Examples:
+--------+--------------------------------+
| n | (Global Owner) |
@@ -1180,7 +1180,9 @@ chanlist <channel> [flags[&chanflags]]
Now you can use even more complex matching of flags, including +&- flags and & or | ('and' or 'or') matching.
Returns: list of nicknames currently on the bot's channel that have all of the flags specified;. If no flags are given, all of the nicknames are returned. Please note that if you're executing chanlist after a part or sign bind, the gone user will still be listed, so you can check for wasop, isop, etc.
Returns: Searching for flags optionally preceded with a '+' will return a list of nicknames that have all the flags listed. Searching for flags preceded with a '-' will return a list of nicknames that do not have have any of the flags (differently said, '-' will hide users that have all flags listed). If no flags are given, all of the nicknames on the channel are returned.
Please note that if you're executing chanlist after a part or sign bind, the gone user will still be listed, so you can check for wasop, isop, etc.
Module: irc

0 comments on commit c399e67

Please sign in to comment.