jabber_mirror: Document which mode handles which kinds of messages

(imported from commit 983224ac58bce724529806f6b8eaa3ea30cc730b)
This commit is contained in:
Zev Benjamin 2014-02-28 15:35:26 -05:00
parent 204e7e7e90
commit b23dc256e4
1 changed files with 15 additions and 0 deletions

View File

@ -23,6 +23,21 @@
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
# The following is a table showing which kinds of messages are handled by the
# mirror in each mode:
#
# Message origin/type --> | Jabber | Zulip
# Mode/sender-, +-----+----+--------+----
# V | MUC | PM | stream | PM
# --------------+-------------+-----+----+--------+----
# | other sender| | x | |
# personal mode +-------------+-----+----+--------+----
# | self sender | | x | x | x
# ------------- +-------------+-----+----+--------+----
# | other sender| x | | |
# public mode +-------------+-----+----+--------+----
# | self sender | | | |
import logging
import threading
import optparse