core: Document irclib.Irc.addCallback.

This commit is contained in:
Valentin Lorentz 2013-02-01 20:38:53 +01:00
parent 75f19a9f50
commit fa36e48075
2 changed files with 6 additions and 1 deletions

View File

@ -1,3 +1,4 @@
# -*- coding: utf8 -*-
###
# Copyright (c) 2002-2005, Jeremiah Fincher
# Copyright (c) 2008-2010, James McCoy

View File

@ -649,7 +649,11 @@ class Irc(IrcCommandDispatcher):
# This *isn't* threadsafe!
def addCallback(self, callback):
"""Adds a callback to the callbacks list."""
"""Adds a callback to the callbacks list.
:param callback: A callback object
:type callback: supybot.irclib.IrcCallback
"""
assert not self.getCallback(callback.name())
self.callbacks.append(callback)
# This is the new list we're building, which will be tsorted.