Limnoria/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Limnoria/Limnoria-doc.git synced 2025-04-07 15:59:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document Irc, IrcState, ChannelState, IrcMsg, and Plugin.

Browse Source
This commit is contained in:
Valentin Lorentz
2013-01-31 20:49:31 +01:00
parent b018a9ce1d
commit e50cfad04d
4 changed files with 74 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
develop/irclib.rst Normal file
View File

@ -0,0 +1,44 @@
.. _supybot-irclib:
**************
supybot.irclib
**************
Most used classes
=================
.. _supybot-irclib-irc:
supybot.irclib.Irc
------------------
It is usually the `irc` object given to plugin commands.
.. autoclass:: supybot.irclib.Irc
:members:
:inherited-members:
.. _supybot-irclib-ircstate:
supybot.irclib.IrcState
-----------------------
Used mainly as the `state` attribute of :py:class:`supybot.irclib.Irc` objects.
.. autoclass:: supybot.irclib.IrcState
:members:
:inherited-members:
.. _supybot-irclib-channelstate:
supybot.irclib.ChannelState
---------------------------
Used mainly as the `channels['#chan']` attribute of
:py:class:`supybot.irclib.Irc` objects.
.. autoclass:: supybot.irclib.ChannelState
:members:
:inherited-members: