From b6e426b9d56f21b3b5350ed5e1977fd19c74d1ca Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Sun, 27 Sep 2020 15:25:52 +0200 Subject: [PATCH] Update autodoc of irclib to work better with the current doc in testing. --- develop/irclib.rst | 33 +++++++++++++++------------------ 1 file changed, 15 insertions(+), 18 deletions(-) diff --git a/develop/irclib.rst b/develop/irclib.rst index c3951ca..64ff8f6 100644 --- a/develop/irclib.rst +++ b/develop/irclib.rst @@ -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