From b319164d8256d7c4dea2296943089041450e3f2b Mon Sep 17 00:00:00 2001 From: Ben Kurtovic Date: Thu, 5 Jul 2012 23:16:07 -0400 Subject: [PATCH] Add delegate() and Category's attrs to documentation. --- docs/toolset.rst | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/toolset.rst b/docs/toolset.rst index d22b4af..06b36bf 100644 --- a/docs/toolset.rst +++ b/docs/toolset.rst @@ -108,6 +108,9 @@ and the following methods: the given title (sans namespace) - :py:meth:`get_user(username) `: returns a :py:class:`~earwigbot.wiki.user.User` object for the given username +- :py:meth:`delegate(services, ...) `: + delegates a task to either the API or SQL depending on various conditions, + such as server lag Pages and categories ~~~~~~~~~~~~~~~~~~~~ @@ -166,9 +169,20 @@ Additionally, :py:class:`~earwigbot.wiki.category.Category` objects (created with :py:meth:`site.get_category(name) ` or :py:meth:`site.get_page(title) ` where ``title`` is in the ``Category:`` namespace) provide the following additional -method: +attributes: -- :py:meth:`get_members(use_sql=False, limit=None, ...) +- :py:attr:`~earwigbot.wiki.category.Category.size`: the total number of + members in the category +- :py:attr:`~earwigbot.wiki.category.Category.pages`: the number of pages in + the category +- :py:attr:`~earwigbot.wiki.category.Category.files`: the number of files in + the category +- :py:attr:`~earwigbot.wiki.category.Category.subcats`: the number of + subcategories in the category + +And the following additional method: + +- :py:meth:`get_members(limit=None, ...) `: iterates over :py:class:`~earwigbot.wiki.page.Page`\ s in the category, until either the category is exhausted or (if given) ``limit`` is reached