Skip to content

Commit

Permalink
[doc] add documentation reference to api:Deletedrevisions
Browse files Browse the repository at this point in the history
Change-Id: Ifeb6cf9a5b0904ac4a5b77792944ea9c3b18311f
  • Loading branch information
xqt committed Feb 2, 2024
1 parent d145fad commit 36e2be0
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
4 changes: 4 additions & 0 deletions docs/mwapi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ See the table below for a cross reference between MediaWiki's API and Pywikibot'
- :meth:`delete()<pywikibot.site._apisite.APISite.delete>`
- :meth:`BasePage.delete()<page.BasePage.delete>`
-
* - :api:`Deletedrevisions<Deletedrevisions>`
- :meth:`delete()<pywikibot.site._apisite.APISite.delete>`
- :meth:`BasePage.delete()<page.BasePage.delete>`
-
* - :api:`echomarkread<echomarkread>`
- :meth:`notifications_mark_read()<pywikibot.site._extensions.EchoMixin.notifications_mark_read>`
-
Expand Down
6 changes: 4 additions & 2 deletions pywikibot/page/_basepage.py
Original file line number Diff line number Diff line change
Expand Up @@ -1943,8 +1943,10 @@ def getDeletedRevision(
content: bool = False,
**kwargs
) -> list:
"""
Return a particular deleted revision by timestamp.
"""Return a particular deleted revision by timestamp.
.. seealso:: :meth:`APISite.deletedrevs()
<pywikibot.site._generators.GeneratorsMixin.deletedrevs>`
:return: a list of [date, editor, comment, text, restoration
marker]. text will be None, unless content is True (or has
Expand Down

0 comments on commit 36e2be0

Please sign in to comment.