jenkins-bot has submitted this change and it was merged.
Change subject: Fix ProofreadPage RST error
......................................................................
Fix ProofreadPage RST error
Change-Id: Iec8b38a41e77dfc8b6cf61bfa0a7d2ae635ac035
---
M pywikibot/proofreadpage.py
1 file changed, 8 insertions(+), 4 deletions(-)
Approvals:
XZise: Looks good to me, approved
jenkins-bot: Verified
diff --git a/pywikibot/proofreadpage.py b/pywikibot/proofreadpage.py
index d27b08b..5d0e9ba 100644
--- a/pywikibot/proofreadpage.py
+++ b/pywikibot/proofreadpage.py
@@ -5,6 +5,7 @@
The extension is supported by MW 1.21+.
This module includes objects:
+
* ProofreadPage(Page)
* FullHeader
* IndexPage(Page)
@@ -105,12 +106,15 @@
def index(self):
"""Get the Index page which contains ProofreadPage.
+ If there are many Index pages link to this ProofreadPage, and
+ the ProofreadPage is titled Page:<index title>/<page number>,
+ the Index page with the same title will be returned.
+ Otherwise None is returned in the case of multiple linked Index pages.
+
To force reload, delete index and call it again.
- Returns:
- None: if ProofreadPage is linked to no or several Index pages
- and no inerence can be done from titles.
- IndexPage: if ProofreadPage is linked to one Index page.
+ @return: the Index page for this ProofreadPage
+ @rtype: IndexPage or None
"""
if not hasattr(self, '_index'):
index_ns = self.site.proofread_index_ns
--
To view, visit
https://gerrit.wikimedia.org/r/246814
To unsubscribe, visit
https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Iec8b38a41e77dfc8b6cf61bfa0a7d2ae635ac035
Gerrit-PatchSet: 5
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Owner: John Vandenberg <jayvdb(a)gmail.com>
Gerrit-Reviewer: John Vandenberg <jayvdb(a)gmail.com>
Gerrit-Reviewer: Ladsgroup <ladsgroup(a)gmail.com>
Gerrit-Reviewer: XZise <CommodoreFabianus(a)gmx.de>
Gerrit-Reviewer: jenkins-bot <>