jenkins-bot merged this change.

View Change

Improve docstrings to the Pywikibot library

Modified docstrings of logenties by adding epytext fields.

Bug: T118423
Change-Id: Ia6dbbb62f1910a86a6a731ce2d6bf183c44d3d0d
---
M pywikibot/logentries.py
1 file changed, 17 insertions(+), 4 deletions(-)

diff --git a/pywikibot/logentries.py b/pywikibot/logentries.py
index b757645..1248334 100644
--- a/pywikibot/logentries.py
+++ b/pywikibot/logentries.py
@@ -223,7 +223,8 @@
 
         It raises an Error if the entry is an unblocking log entry.
 
-        @rtype: list of flag strings
+        @return: list of flags strings
+        @rtype: list
         """
         if self.action() == 'unblock':
             return []
@@ -340,7 +341,11 @@
 
     @property
     def target_page(self):
-        """Return target page object."""
+        """
+        Return target page object.
+
+        @rtype: pywikibot.Page
+        """
         if not hasattr(self, '_target_page'):
             self._target_page = pywikibot.Page(self.site, self.target_title)
         return self._target_page
@@ -363,7 +368,11 @@
 
     @property
     def current_id(self):
-        """Return the current id."""
+        """
+        Return the current id.
+
+        @rtype: int
+        """
         # key has been changed in mw 1.19; try the new mw style first
         # sometimes it returns strs sometimes ints
         return int(self._params['curid']
@@ -371,7 +380,11 @@
 
     @property
     def previous_id(self):
-        """Return the previous id."""
+        """
+        Return the previous id.
+
+        @rtype: int
+        """
         # key has been changed in mw 1.19; try the new mw style first
         # sometimes it returns strs sometimes ints
         return int(self._params['previd']

To view, visit change 497804. To unsubscribe, or for help writing mail filters, visit settings.