Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/851596 )
Change subject: [doc] Update documentatin of Category.members() and Category.categoryinfo
......................................................................
[doc] Update documentatin of Category.members() and Category.categoryinfo
Change-Id: I18f1af3b23e1ed63869823e0390a95b863805a83
---
M pywikibot/page/_category.py
1 file changed, 12 insertions(+), 8 deletions(-)
Approvals:
Xqt: Verified; Looks good to me, approved
diff --git a/pywikibot/page/_category.py b/pywikibot/page/_category.py
index 0c9a209..173bf67 100644
--- a/pywikibot/page/_category.py
+++ b/pywikibot/page/_category.py
@@ -8,7 +8,7 @@
from typing import Any, Optional, Union
import pywikibot
-from pywikibot.backports import Generator, Iterable
+from pywikibot.backports import Dict, Generator, Iterable
from pywikibot.page._page import Page
@@ -185,11 +185,14 @@
>>> list(cat.members(member_type=['page', 'file']))
[Page('Pywikibot nobots test')]
- Calling this method with ``member_type='subcat'`` is *almost*
- equal to calling :meth:`subcategories`. Calling this method with
+ Calling this method with ``member_type='subcat'`` is equal to
+ calling :meth:`subcategories`. Calling this method with
``member_type=['page', 'file']`` is equal to calling
:meth:`articles`.
+ .. seealso:: :meth:`APISite.categorymembers()
+ <pywikibot.site._generators.GeneratorsMixin.categorymembers>`
+
.. versionchanged:: 8.0
all parameters are keyword arguments only. Additional
parameters are supported.
@@ -245,13 +248,14 @@
return 'hiddencat' in self.properties()
@property
- def categoryinfo(self) -> dict:
- """
- Return a dict containing information about the category.
+ def categoryinfo(self) -> Dict[str, Any]:
+ """Return a dict containing information about the category.
- The dict contains values for:
+ The dict contains values for numbers of pages, subcategories,
+ files, and total contents.
- Numbers of pages, subcategories, files, and total contents.
+ .. seealso:: :meth:`APISite.categoryinfo()
+ <pywikibot.site._apisite.APISite.categoryinfo>`
"""
return self.site.categoryinfo(self)
--
To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/851596
To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Change-Id: I18f1af3b23e1ed63869823e0390a95b863805a83
Gerrit-Change-Number: 851596
Gerrit-PatchSet: 1
Gerrit-Owner: Xqt <info(a)gno.de>
Gerrit-Reviewer: Xqt <info(a)gno.de>
Gerrit-Reviewer: jenkins-bot
Gerrit-MessageType: merged