jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/843962 ) Change subject: [IMPR] Improvements for Category.aslink() ...................................................................... [IMPR] Improvements for Category.aslink() Change-Id: Icaba23ada1d825e95b61c2b23d56082f4fbd093e --- M pywikibot/page/_category.py 1 file changed, 17 insertions(+), 7 deletions(-) Approvals: Matěj Suchánek: Looks good to me, approved Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/page/_category.py b/pywikibot/page/_category.py index 69bdf0d..37415b2 100644 --- a/pywikibot/page/_category.py +++ b/pywikibot/page/_category.py @@ -32,20 +32,30 @@ .format(self.title())) def aslink(self, sort_key: Optional[str] = None) -> str: - """ - Return a link to place a page in this Category. + """Return a link to place a page in this Category. - Use this only to generate a "true" category link, not for interwikis - or text links to category pages. + .. warning:: Use this only to generate a "true" category link, + not for interwikis or text links to category pages. + + **Usage:** + + >>> site = pywikibot.Site('wikipedia:test') + >>> cat = pywikibot.Category(site, 'Foo') + >>> cat.aslink() + '[[Category:Foo]]' + >>> cat = pywikibot.Category(site, 'Foo', sort_key='bar') + >>> cat.aslink() + '[[Category:Foo|bar]]' + >>> cat.aslink('baz') + '[[Category:Foo|baz]]' :param sort_key: The sort key for the article to be placed in this Category; if omitted, default sort key is used. """ key = sort_key or self.sortKey + title_with_sort_key = self.title(with_section=False) if key is not None: - title_with_sort_key = self.title(with_section=False) + '|' + key - else: - title_with_sort_key = self.title(with_section=False) + title_with_sort_key += '|' + key return f'[[{title_with_sort_key}]]' def subcategories(self, -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/843962 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: Icaba23ada1d825e95b61c2b23d56082f4fbd093e Gerrit-Change-Number: 843962 Gerrit-PatchSet: 2 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Matěj Suchánek <matejsuchanek97(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged