Mikaela/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria-doc.git synced 2025-02-16 13:30:57 +01:00
Code Issues Projects Releases Wiki Activity

Update autodoc of irclib to work better with the current doc in testing.

Browse Source
This commit is contained in:
Valentin Lorentz 2020-09-27 15:25:52 +02:00
parent ccc507d164
commit b6e426b9d5
1 changed files with 15 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
develop/irclib.rst
View File

@ -15,35 +15,32 @@ It is usually the `irc` object given to plugin commands.
:members:
:inherited-members:
.. attribute:: zombie
Whether or not this object represents a living IRC connection.
:type: bool
.. attribute:: network
The name of the network this object is connected to.
:type: str
.. attribute:: startedAt
:type: float
.. _supybot-irclib-ircstate:
IrcState
========
Used mainly as the `state` attribute of :py:class:`supybot.irclib.Irc` objects.
Used mainly as the ``state`` attribute of :py:class:`supybot.irclib.Irc` objects.
.. autoclass:: supybot.irclib.IrcState
:members:
:inherited-members:
.. _supybot-irclib-ircstatefsm:
IrcStateFsm
===========
Used as the ``fsm`` attribute of :py:class:`supybot.irclib.IrcState` objects
.. autoclass:: supybot.irclib.IrcStateFsm
:members:
:inherited-members:
.. _supybot-irclib-channelstate:
ChannelState
@ -61,4 +58,4 @@ Other classes
.. automodule:: supybot.irclib
:members:
:exclude-members: Irc, IrcState, ChannelState
:exclude-members: Irc, IrcState, IrcStateFsm, ChannelState