From 6c503b36037af8975b5f9174d2f22cb6490dd4a9 Mon Sep 17 00:00:00 2001 From: James Lu Date: Sun, 6 Sep 2015 23:18:27 -0700 Subject: [PATCH] Fix typos and other stupid mistakes... --- .../{inspircd_protocol.html => inspircd.html} | 34 +++++++------------ docs/technical/pmodule-spec.md | 2 +- protocols/inspircd.py | 12 +++---- protocols/ts6_common.py | 6 ++-- 4 files changed, 21 insertions(+), 33 deletions(-) rename docs/technical/{inspircd_protocol.html => inspircd.html} (93%) diff --git a/docs/technical/inspircd_protocol.html b/docs/technical/inspircd.html similarity index 93% rename from docs/technical/inspircd_protocol.html rename to docs/technical/inspircd.html index f783fa3..4f01b32 100644 --- a/docs/technical/inspircd_protocol.html +++ b/docs/technical/inspircd.html @@ -113,13 +113,9 @@ to our PINGs eventually times out and is 
joinClient(self, client, channel)
Joins an internal spawned client <client> to a channel.
-
killClient(self, numeric, target, reason)
<self.irc object> <client numeric> <target> <reason>
- 
-Sends a kill to <target> from a PyLink PseudoClient.
+
killClient(self, numeric, target, reason)
Sends a kill from a PyLink client.
-
killServer(self, numeric, target, reason)
<self.irc object> <server SID> <target> <reason>
- 
-Sends a kill to <target> from a PyLink PseudoServer.
+
killServer(self, numeric, target, reason)
Sends a kill from a PyLink server.
knockClient(self, numeric, target, text)
Sends a KNOCK from a PyLink client.
@@ -141,8 +137,8 @@ to the one we've stored in the channel s <users> is a list of (prefix mode, UID) pairs:
 
Example uses:
-    sjoinServer(self.irc, '100', '#test', [('', '100AAABBC'), ('qo', 100AAABBB'), ('h', '100AAADDD')])
-    sjoinServer(self.irc, self.irc.sid, '#test', [('o', self.irc.pseudoclient.uid)]) +    sjoinServer('100', '#test', [('', '100AAABBC'), ('qo', 100AAABBB'), ('h', '100AAADDD')])
+    sjoinServer(self.irc.sid, '#test', [('o', self.irc.pseudoclient.uid)])
spawnClient(self, nick, ident='null', host='null', realhost=None, modes=set(), server=None, ip='0.0.0.0', realname=None, ts=None, opertype=None)
Spawns a client with nick <nick> on the given IRC connection.
 
@@ -166,7 +162,7 @@ Methods inherited from ts6_common.TS6B
handle_kill(self, source, command, args)
Handles incoming KILLs.
handle_mode(self, numeric, command, args)
Handles incoming user mode changes. For channel mode changes,
-TMODE (TS6/charybdis) and FMODE (Inspself.ircd) are used instead.
+TMODE (TS6/charybdis) and FMODE (InspIRCd) are used instead.
handle_nick(self, numeric, command, args)
Handles incoming NICK changes.
@@ -183,7 +179,7 @@ TMODE (TS6/charybdis) and FMODE (Inspself.ircd) are&nbs
handle_squit(self, numeric, command, args)
Handles incoming SQUITs (netsplits).
handle_topic(self, numeric, command, args)
Handles incoming TOPIC changes from clients. For topic bursts,
-TB (TS6/charybdis) and FTOPIC (Inspself.ircd) are used instead.
+TB (TS6/charybdis) and FTOPIC (InspIRCd) are used instead.
kickClient(self, numeric, channel, target, reason=None)
Sends a kick from a PyLink client.
@@ -288,13 +284,9 @@ to our PINGs eventually times out and is 
joinClient(self, client, channel)
Joins an internal spawned client <client> to a channel.
-
killClient(self, numeric, target, reason)
<self.irc object> <client numeric> <target> <reason>
- 
-Sends a kill to <target> from a PyLink PseudoClient.
+
killClient(self, numeric, target, reason)
Sends a kill from a PyLink client.
-
killServer(self, numeric, target, reason)
<self.irc object> <server SID> <target> <reason>
- 
-Sends a kill to <target> from a PyLink PseudoServer.
+
killServer(self, numeric, target, reason)
Sends a kill from a PyLink server.
knockClient(self, numeric, target, text)
Sends a KNOCK from a PyLink client.
@@ -316,8 +308,8 @@ to the one we've stored in the channel s <users> is a list of (prefix mode, UID) pairs:
 
Example uses:
-    sjoinServer(self.irc, '100', '#test', [('', '100AAABBC'), ('qo', 100AAABBB'), ('h', '100AAADDD')])
-    sjoinServer(self.irc, self.irc.sid, '#test', [('o', self.irc.pseudoclient.uid)]) +    sjoinServer('100', '#test', [('', '100AAABBC'), ('qo', 100AAABBB'), ('h', '100AAADDD')])
+    sjoinServer(self.irc.sid, '#test', [('o', self.irc.pseudoclient.uid)])
spawnClient(self, nick, ident='null', host='null', realhost=None, modes=set(), server=None, ip='0.0.0.0', realname=None, ts=None, opertype=None)
Spawns a client with nick <nick> on the given IRC connection.
 
@@ -341,7 +333,7 @@ Methods inherited from ts6_common.TS6B
handle_kill(self, source, command, args)
Handles incoming KILLs.
handle_mode(self, numeric, command, args)
Handles incoming user mode changes. For channel mode changes,
-TMODE (TS6/charybdis) and FMODE (Inspself.ircd) are used instead.
+TMODE (TS6/charybdis) and FMODE (InspIRCd) are used instead.
handle_nick(self, numeric, command, args)
Handles incoming NICK changes.
@@ -358,7 +350,7 @@ TMODE (TS6/charybdis) and FMODE (Inspself.ircd) are&nbs
handle_squit(self, numeric, command, args)
Handles incoming SQUITs (netsplits).
handle_topic(self, numeric, command, args)
Handles incoming TOPIC changes from clients. For topic bursts,
-TB (TS6/charybdis) and FTOPIC (Inspself.ircd) are used instead.
+TB (TS6/charybdis) and FTOPIC (InspIRCd) are used instead.
kickClient(self, numeric, channel, target, reason=None)
Sends a kick from a PyLink client.
@@ -399,7 +391,7 @@ Data descriptors inherited from classes.Protocol Data         -conf = {'bot': {'loglevel': 'CRITICAL', 'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'servers': defaultdict(<function <lambda> at 0x7f47d93ddc80>, {})}
+conf = {'bot': {'loglevel': 'CRITICAL', 'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'servers': defaultdict(<function <lambda> at 0x7f0dbb516c80>, {})}
curdir = 'protocols'
log = <logging.RootLogger object> \ No newline at end of file diff --git a/docs/technical/pmodule-spec.md b/docs/technical/pmodule-spec.md index 257c9f9..777feca 100644 --- a/docs/technical/pmodule-spec.md +++ b/docs/technical/pmodule-spec.md @@ -1,4 +1,4 @@ -This page is still incomplete. See [inspircd_protocol.html](inspircd_protocol.html) for an auto-generated specification of the protocol module. Any camelCase `ABCServer/Client` functions are outgoing commands, and include the following: +This page is still incomplete. For now, see [inspircd.html](inspircd.html) for an auto-generated specification of the InspIRCd protocol module. Any camelCase `ABCServer/Client` functions are outgoing commands, and include the following: - `awayClient` - `inviteClient` diff --git a/protocols/inspircd.py b/protocols/inspircd.py index f6e4df8..389fe47 100644 --- a/protocols/inspircd.py +++ b/protocols/inspircd.py @@ -83,8 +83,8 @@ class InspIRCdProtocol(TS6BaseProtocol): is a list of (prefix mode, UID) pairs: Example uses: - sjoinServer(self.irc, '100', '#test', [('', '100AAABBC'), ('qo', 100AAABBB'), ('h', '100AAADDD')]) - sjoinServer(self.irc, self.irc.sid, '#test', [('o', self.irc.pseudoclient.uid)]) + sjoinServer('100', '#test', [('', '100AAABBC'), ('qo', 100AAABBB'), ('h', '100AAADDD')]) + sjoinServer(self.irc.sid, '#test', [('o', self.irc.pseudoclient.uid)]) """ channel = utils.toLower(self.irc, channel) server = server or self.irc.sid @@ -191,9 +191,7 @@ class InspIRCdProtocol(TS6BaseProtocol): self._sendModes(numeric, target, modes, ts=ts) def killServer(self, numeric, target, reason): - """ - - Sends a kill to from a PyLink PseudoServer. + """Sends a kill from a PyLink server. """ if not utils.isInternalServer(self.irc, numeric): raise LookupError('No such PyLink PseudoServer exists.') @@ -202,9 +200,7 @@ class InspIRCdProtocol(TS6BaseProtocol): # will send a QUIT from the target if the command succeeds. def killClient(self, numeric, target, reason): - """ - - Sends a kill to from a PyLink PseudoClient. + """Sends a kill from a PyLink client. """ if not utils.isInternalClient(self.irc, numeric): raise LookupError('No such PyLink PseudoClient exists.') diff --git a/protocols/ts6_common.py b/protocols/ts6_common.py index 2d1efe2..4e87182 100644 --- a/protocols/ts6_common.py +++ b/protocols/ts6_common.py @@ -217,8 +217,8 @@ class TS6BaseProtocol(Protocol): def handle_mode(self, numeric, command, args): """Handles incoming user mode changes. For channel mode changes, - TMODE (TS6/charybdis) and FMODE (Inspself.ircd) are used instead.""" - # In Inspself.ircd, MODE is used for setting user modes and + TMODE (TS6/charybdis) and FMODE (InspIRCd) are used instead.""" + # In InspIRCd, MODE is used for setting user modes and # FMODE is used for channel modes: # <- :70MAAAAAA MODE 70MAAAAAA -i+xc target = args[0] @@ -229,7 +229,7 @@ class TS6BaseProtocol(Protocol): def handle_topic(self, numeric, command, args): """Handles incoming TOPIC changes from clients. For topic bursts, - TB (TS6/charybdis) and FTOPIC (Inspself.ircd) are used instead.""" + TB (TS6/charybdis) and FTOPIC (InspIRCd) are used instead.""" # <- :70MAAAAAA TOPIC #test :test channel = utils.toLower(self.irc, args[0]) topic = args[1]