3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-01 17:29:21 +01:00
Commit Graph

146 Commits

Author SHA1 Message Date
James Lu
86bfda7281 services-api: various wording and typo fixes
[ci skip]
2018-07-02 00:57:36 -07:00
James Lu
a74fe9bf08 writing-plugins: refer to the services API guide for utils.add_cmd features 2018-07-02 00:47:30 -07:00
James Lu
b2e85fa385 services-api: mention command alias support in 2.0-alpha1+ 2018-07-02 00:45:11 -07:00
James Lu
0ccaac595b services-api: refresh + expand for 2.0 and the persistent channel rework
Closes #603.

Other changes:
- Move the "Removing services" section to earlier in the doc - it is important!
- Consistently use 'strings' instead of "strings" in example code
- Mention briefly how "spawn_service:" false affects plugins
- Mention the "dynamic" channel handling added in 2.0-alpha3
2018-07-02 00:35:31 -07:00
James Lu
348dc7348c services-api: use snake case function names for (un)register_service()
[skip ci]
2018-07-01 23:36:14 -07:00
James Lu
f90ec284a4 pmodule-spec: document protocol capabilities
Closes #436.
2018-06-26 22:47:39 -07:00
James Lu
bdd568f75b pmodule-spec: consistently refer to protocol module attrs as self.<whatever> instead of irc.<whatever>
[skip ci]
2018-06-26 22:23:35 -07:00
James Lu
a548ae0714 pmodule-spec: reflow, mention self.connected in Special variables
[skip ci]
2018-06-26 22:20:28 -07:00
James Lu
763ffcf903 pmodule-spec: various wording tweaks
[skip ci]
2018-06-26 22:14:38 -07:00
James Lu
c48846727e pmodule-spec: fix link to protocol-modules.svg
[skip ci]
2018-06-26 22:02:09 -07:00
James Lu
420f523dfd writing-plugins: briefly mention log, world, irc.connected, and useful builtin modules
Closes #522.
2018-06-26 21:58:17 -07:00
James Lu
e340f6e9a2 writing-plugins.md: rewrite for clarity for conciseness
Also document the introduction of hook handler return values and irc.error()

[skip ci]
2018-06-26 21:36:17 -07:00
James Lu
f54382534c kick and kill should raise NotImplementedError when not supported by a protocol
Closes #605.
2018-05-09 22:19:03 -07:00
James Lu
31c96bd1ed hooks-reference: bump to 2.0-alpha2
- Replace `IrcChannel`, `IrcUser`, and `IrcServer` with their new class names (`classes.Channel`, `classes.User`, and `classes.Server`)
- Replace `irc.fullVersion()` with `irc.version()`
- Various minor wording tweaks.
2018-01-13 18:23:12 -08:00
James Lu
06ee01b7a7 hooks-reference: don't use the wrong terminology in example channel names 2018-01-13 18:23:12 -08:00
James Lu
f969197436 Convert protocol-modules graphic to a .svg 2017-11-12 12:07:08 -08:00
James Lu
5e7469b56f Remove protocols/ratbox, superseded by ts6
Closes #543.
2017-10-22 01:06:55 -07:00
James Lu
48aab1cf16 docs/services-api: revise
- Rewrite lead section to be more concise
- Move to snake case method names
- Consistently use the terms "services" and "service bots"

[skip ci]
2017-10-05 19:21:52 -07:00
James Lu
39b1e28061 Remove plugins/example_service, it is out of date and broken with 2.x
Closes #532.
2017-10-05 19:08:28 -07:00
James Lu
f79168ce5f docs/t: remove future articles that won't be around for a while
[skip ci]
2017-10-05 19:05:36 -07:00
James Lu
5574c746b9 docs: update table of contents
Mode lists are in a separate folder now.

[skip ci]
2017-10-05 19:04:45 -07:00
James Lu
82a6ceb99e docs: Refresh release-process.md
[skip ci]
2017-10-05 18:20:59 -07:00
James Lu
f0d1c1bb89 pmodule-spec: mention in detail how users are tracked
Closes #478.
2017-10-05 18:18:09 -07:00
James Lu
8fff9ea641 pmodule-spec: mention post_connect definition for IRCNetwork derivatives (#478) 2017-10-05 18:18:09 -07:00
James Lu
499fe319aa permissions-api: fix markdown syntax [skip ci] 2017-09-08 19:02:51 -07:00
James Lu
4cf7b36b7b permissions-api: clarify how globs are processed
[skip ci]
2017-09-08 19:02:03 -07:00
James Lu
5084cc2c69 pmodule-spec: rewording, fix headings 2017-08-30 01:29:09 -07:00
James Lu
46e9975bd5 Continue rewriting the protocol module spec (#478) 2017-08-30 01:26:35 -07:00
James Lu
5b941daf4d Begin rewriting the protocol spec for PyLink 2.0 (#478) 2017-08-30 00:34:42 -07:00
James Lu
89699051d5 Services API rework
- Move nick/ident/host/gecos fetching from services_support into functions
- Remove the unused 'ident' argument from ServiceBot
- Rename the 'nick' argument in ServiceBot to 'default_nick'
- Define default nicks for the PyLink, Automode, and Games services
2017-08-21 21:51:45 -07:00
James Lu
92dae6db5e docs/t: link to html versions of mode lists 2017-08-11 15:19:46 -07:00
James Lu
4c0d765a2f docs: revamp mode list docs
- HTML version now available via a .csv -> .html generator script
- Addded a column for ChatIRCd
2017-08-11 15:14:55 -07:00
James Lu
c107f0062f hybrid, ts6, ratbox: fix +p mode definitions properly
+p is noknock and rfc1459-style private on all 3 IRCds, though the latter bit is undocumented in /help cmodes (maybe it's assumed?)
+p is also "paranoia" on hybrid, which adds more restrictions to halfops and /invite
2017-08-11 13:45:40 -07:00
James Lu
5a00a632d6 Remove core-structure doc, outdated and not really useful 2017-08-06 23:13:20 -07:00
James Lu
b9a5de16de user-modes.csv: fix wrong names for sno_serverconnects, sno_stats 2017-07-31 00:57:51 +08:00
James Lu
0a56ab662b channel/user-modes.csv: add RFC1459 & ngIRCd columns 2017-07-31 00:56:10 +08:00
James Lu
faa5b729d9 docs: update protocol-modules graphic 2017-07-05 03:28:28 -07:00
James Lu
04c18f0bd5 docs: get rid of self.irc, self.proto, irc.proto 2017-06-25 02:10:03 -07:00
James Lu
69c25b5954 channel-modes: document UnrealIRCd +D and +V 2017-04-02 14:04:44 -07:00
James Lu
36f9bef450 docs/t: refresh protocol-modules graphic 2017-03-25 13:47:16 -07:00
James Lu
7acfd80387 Update named mode definitions 2017-03-25 13:47:16 -07:00
James Lu
61cf48c37c pmodule-spec: various fixes
- Corrected the location of the `self.irc.cmodes/umodes/prefixmodes` attributes
- Mention `self.conf_keys` as a special variable for completeness
2017-03-15 23:11:44 -07:00
James Lu
7892e37bfa Documentation tweaks
- Add advanced-service-config to TOC
- Move "matching SERVICE name" note to docs/t/services-api.md
- Various wording / grammar tweaks
2017-03-13 13:50:16 -07:00
James Lu
2e0c7db4e3 using-ircparser.md: minor tweaks and reordering
Thanks again to @IotaSpencer for writing this article :)
2017-03-12 20:45:42 -07:00
James Lu
75ea743b4a docs/t: link to using-ircparser.md in contents 2017-03-12 20:38:58 -07:00
James Lu
c8f945d40f writing-plugins.md: mention that IRCParser is a 1.2+ feature 2017-03-12 20:37:53 -07:00
Ken Spencer
d6d330bec6 Add docs/technical/using-ircparser.md guide. 2017-03-12 23:08:56 -04:00
Ken Spencer
ed7a117247 doc/technical/writing-plugins.md: mention and link to using-ircparser.md 2017-03-12 21:55:22 -04:00
James Lu
6fcb129ad6 hooks-reference: document the 'was_successful' key in PYLINK_DISCONNECT 2017-02-24 22:27:51 -08:00
James Lu
a7280d2943 docs/t: more notes regarding the permissions API 2017-02-24 18:31:26 -08:00