John Vandenberg has uploaded a new change for review.

  https://gerrit.wikimedia.org/r/238086

Change subject: Add whitespace in docstrings
......................................................................

Add whitespace in docstrings

Change-Id: I0b05d923dd5cde11bc6296ce85d3e1b832c9fe0e
---
M pywikibot/comms/rcstream.py
M pywikibot/exceptions.py
M pywikibot/pagegenerators.py
M pywikibot/tools/__init__.py
4 files changed, 12 insertions(+), 5 deletions(-)


  git pull ssh://gerrit.wikimedia.org:29418/pywikibot/core 
refs/changes/86/238086/1

diff --git a/pywikibot/comms/rcstream.py b/pywikibot/comms/rcstream.py
index 438823a..68ebded 100644
--- a/pywikibot/comms/rcstream.py
+++ b/pywikibot/comms/rcstream.py
@@ -27,7 +27,7 @@
 class RcListenerThread(threading.Thread):
 
     """
-    Low-level RC Listener Thread, which reads the RC stream and pushes them to 
it's internal queue.
+    Low-level RC Listener Thread, pushing RC stream events into a queue.
 
     @param wikihost: the hostname of the wiki we want to get changes for. This
                      is passed to rcstream using a 'subscribe' command. Pass
@@ -45,6 +45,7 @@
     to a single site and pushes those entries into a queue.
 
     Usage:
+
     >>> t = RcListenerThread('en.wikipedia.org', 'stream.wikimedia.org')
     >>> t.start()
     >>> change = t.queue.get()
diff --git a/pywikibot/exceptions.py b/pywikibot/exceptions.py
index a8a8beb..5d2c48c 100644
--- a/pywikibot/exceptions.py
+++ b/pywikibot/exceptions.py
@@ -30,7 +30,7 @@
   - NoMoveTarget: An expected move target page does not exist
 
 PageSaveRelatedError: page exceptions within the save operation on a Page
-(alias: PageNotSaved).
+    (alias: PageNotSaved).
   - SpamfilterError: MediaWiki spam filter detected a blacklisted URL
   - OtherPageSaveError: misc. other save related exception.
   - LockedPage: Page is locked
diff --git a/pywikibot/pagegenerators.py b/pywikibot/pagegenerators.py
index 8e42bf5..e624232 100644
--- a/pywikibot/pagegenerators.py
+++ b/pywikibot/pagegenerators.py
@@ -100,7 +100,9 @@
 
 -logevents        Work on articles that were on a specified Special:Log.
                   The value may be a comma separated list of three values:
+
                       logevent,username,total
+
                   To use the default value, use an empty string.
                   You have options for every type of logs given by the
                   log event parameter which could be one of the following:
@@ -108,11 +110,14 @@
                       patrol, merge, suppress, review, stable, gblblock,
                       renameuser, globalauth, gblrights, abusefilter, newusers
                   It uses the default number of pages 10.
+
                   Examples:
+
                   -logevents:move gives pages from move log (usually redirects)
                   -logevents:delete,,20 gives 20 pages from deletion log
                   -logevents:protect,Usr gives pages from protect by user Usr
                   -logevents:patrol,Usr,20 gives 20 patroled pages by user Usr
+
                   In some cases it must be written as 
-logevents:"patrol,Usr,20"
 
 -namespaces       Filter the page generator to only yield pages in the
diff --git a/pywikibot/tools/__init__.py b/pywikibot/tools/__init__.py
index af11913..1f3c18a 100644
--- a/pywikibot/tools/__init__.py
+++ b/pywikibot/tools/__init__.py
@@ -386,6 +386,7 @@
     Two versions are equal if their normal version and dev version are equal. A
     version is greater if the normal version or dev version is greater. For
     example:
+
         1.24 < 1.24.1 < 1.25wmf1 < 1.25alpha < 1.25beta1 < 1.25beta2
         < 1.25-rc-1 < 1.25-rc.2 < 1.25
 
@@ -854,9 +855,9 @@
     used as a context manager in with-statements. In such statements the value
     set via 'as' is directly the wrapped object. For example:
 
-     wrapped = ContextManagerWrapper(an_object)
-     with wrapped as another_object:
-         assert(another_object is an_object)
+       wrapped = ContextManagerWrapper(an_object)
+       with wrapped as another_object:
+           assert(another_object is an_object)
 
     It does not subclass the object though, so isinstance checks will fail
     outside a with-statement.

-- 
To view, visit https://gerrit.wikimedia.org/r/238086
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I0b05d923dd5cde11bc6296ce85d3e1b832c9fe0e
Gerrit-PatchSet: 1
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Owner: John Vandenberg <[email protected]>

_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to