jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/678359 )
Change subject: [doc] Update documentation ......................................................................
[doc] Update documentation
* category.py: See Note (1) * claimit.py: See Note (1) * clean_sandbox.py: Use correct English in doc * commons_information.py: See Note (1) * illustrate_wikidata.py: See Note (1) * listpages.py: Better doc * movepages.py: Use correct English in doc * parser_function_count.py: There was a missing + * replicate_wiki.py: Remove extra space from doc * revertbot.py: More descriptive documentation * shell.py: See Note (1) * touch.py: A (slightly better) English wording * transferbot.py: See Note (1) * watchlists.py: More descriptive documentation * casechecker.py: Use better English * commons_link.py: Use better English * editarticle.py: See Note (1) * followlive.py: See Note (2) * imagecopy.py: See Note (1) * imageuncat.py: See Note (1) * table2wiki.py: See Note (1)
* Notes: * (1) Use Full stops consistently at the end of lines * (2) wikipedia --> Wikipedia
Change-Id: I42d376ed1a170cf4f08982f69361bdfc53c0dd7f --- M scripts/README.rst 1 file changed, 24 insertions(+), 24 deletions(-)
Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified
diff --git a/scripts/README.rst b/scripts/README.rst index bd3511d..8e6cfa4 100644 --- a/scripts/README.rst +++ b/scripts/README.rst @@ -25,7 +25,7 @@ | basic.py | Is a template from which simple bots can be made. | +------------------------+---------------------------------------------------------+ | category.py | Add a category link to all pages mentioned on a page, | - | | change or remove category tags | + | | change or remove category tags. | +------------------------+---------------------------------------------------------+ | category_redirect.py | Maintain category redirects and replace links to | | | redirected categories. | @@ -36,15 +36,15 @@ | | description is present and if there are other problems | | | in the image's description. | +------------------------+---------------------------------------------------------+ - | claimit.py | Adds claims to Wikidata items based on categories | + | claimit.py | Adds claims to Wikidata items based on categories. | +------------------------+---------------------------------------------------------+ - | clean_sandbox.py | This bot makes the cleaned of the page of tests. | + | clean_sandbox.py | This bot resets a sandbox with predefined text. | +------------------------+---------------------------------------------------------+ | commonscat.py | Adds {{commonscat}} to Wikipedia categories (or | - | | articles), if other language wikipedia already has such | - | | a template | + | | articles), if other language Wikipedia already has such | + | | a template. | +------------------------+---------------------------------------------------------+ - | commons_information.py | Insert a language template into the description field | + | commons_information.py | Insert a language template into the description field. | +------------------------+---------------------------------------------------------+ | coordinate_import.py | Coordinate importing script. | +------------------------+---------------------------------------------------------+ @@ -59,7 +59,7 @@ +------------------------+---------------------------------------------------------+ | harvest_template.py | [IMPROV] Reduce maximum line length to 130 | +------------------------+---------------------------------------------------------+ - | illustrate_wikidata.py | Don't use 'gen' to refer to the generator factory | + | illustrate_wikidata.py | Don't use 'gen' to refer to the generator factory. | +------------------------+---------------------------------------------------------+ | imagetransfer.py | Given a wiki page, check the interwiki links for | | | images, and let the user choose among them for | @@ -70,14 +70,14 @@ +------------------------+---------------------------------------------------------+ | interwikidata.py | Script to handle interwiki links based on Wikibase. | +------------------------+---------------------------------------------------------+ - | listpages.py | listpages: report number of pages found | + | listpages.py | Print a list of pages, defined by a page generator. | +------------------------+---------------------------------------------------------+ | login.py | Script to log the bot in to a wiki account. | +------------------------+---------------------------------------------------------+ | misspelling.py | Similar to solve_disambiguation.py. It is supposed to | | | fix links that contain common spelling mistakes. | +------------------------+---------------------------------------------------------+ - | movepages.py | Bot page moves to another title. | + | movepages.py | Bot that can move pages to another title. | +------------------------+---------------------------------------------------------+ | newitem.py | Script creates new items on Wikidata based on criteria. | +------------------------+---------------------------------------------------------+ @@ -87,7 +87,7 @@ +------------------------+---------------------------------------------------------+ | pagefromfile.py | This bot takes its input from a file that contains a | | | number of pages to be put on the wiki. | - +------------------------+---------------------------------------------------------+ + +------------------------+--+------------------------------------------------------+ | parser_function_count.py | Find expensive templates that are subject to be | | | converted to Lua. | +------------------------+--+------------------------------------------------------+ @@ -107,11 +107,11 @@ | | text files. The bot can either work on a set of given | | | pages or crawl an SQL dump. | +------------------------+---------------------------------------------------------+ - | replicate_wiki.py | Replicates pages in wiki to a second wiki within family| + | replicate_wiki.py | Replicates pages in wiki to a second wiki within family | +------------------------+---------------------------------------------------------+ - | revertbot.py | Revert edits. | + | revertbot.py | Script that can be used for reverting certain edits. | +------------------------+---------------------------------------------------------+ - | shell.py | Spawns an interactive Python shell | + | shell.py | Spawns an interactive Python shell. | +------------------------+---------------------------------------------------------+ | solve_disambiguation.py| Interactive robot doing disambiguation. | +------------------------+---------------------------------------------------------+ @@ -124,9 +124,9 @@ | | of templates. | +------------------------+---------------------------------------------------------+ | touch.py | Bot goes over all pages of the home wiki, and edits | - | | them without changing. | + | | them without changes. | +------------------------+---------------------------------------------------------+ - | transferbot.py | Transfers pages from a source wiki to a target wiki | + | transferbot.py | Transfers pages from a source wiki to a target wiki. | +------------------------+---------------------------------------------------------+ | unusedfiles.py | Bot appends some text to all unused images and other | | | text to the respective uploaders. | @@ -136,7 +136,7 @@ | version.py | Outputs Pywikibot's revision number, Python's version | | | and OS used. | +------------------------+---------------------------------------------------------+ - | watchlists.py | Information retrieved by watchlist.py will be stored | + | watchlists.py | Allows access to the account's watchlist. | +------------------------+---------------------------------------------------------+ | weblinkchecker.py | Check if external links are still working. | +------------------------+---------------------------------------------------------+ @@ -153,13 +153,13 @@ +------------------------+---------------------------------------------------------+ | capitalize_redirects.py| Script to create a redirect of capitalize articles. | +------------------------+---------------------------------------------------------+ - | casechecker.py | Script to enumerate all pages in the wikipedia and | + | casechecker.py | Script to enumerate all pages in Wikipedia and | | | find all titles with mixed Latin and Cyrillic | | | alphabets. | +------------------------+---------------------------------------------------------+ | catall.py | Add or change categories on a number of pages. | +------------------------+---------------------------------------------------------+ - | commons_link.py | This robot include commons template to linking Commons | + | commons_link.py | This robot includes commons template to link Commons | | | and your wiki project. | +------------------------+---------------------------------------------------------+ | create_categories.py | Program to batch create categories. | @@ -171,11 +171,11 @@ | djvutext.py | Extracts OCR text from djvu files and uploads onto | | | pages in the "Page" namespace on Wikisource. | +------------------------+---------------------------------------------------------+ - | editarticle.py | Edit a Wikipedia article with your favourite editor | + | editarticle.py | Edit a Wikipedia article with your favourite editor. | +------------------------+---------------------------------------------------------+ | flickrripper.py | Upload images from Flickr easily. | +------------------------+---------------------------------------------------------+ - | followlive.py | follow new articles on a wikipedia and flag them | + | followlive.py | follow new articles on a Wikipedia and flag them | | | with a template. | +------------------------++--------------------------------------------------------+ | freebasemappingupload.py| Docstring fixes in scripts | @@ -183,7 +183,7 @@ | image.py | This script can be used to change one image to another | | | or remove an image entirely. | +------------------------+---------------------------------------------------------+ - | imagecopy.py | Copies images from a Wikimedia wiki to Commons | + | imagecopy.py | Copies images from a Wikimedia wiki to Commons. | +------------------------+---------------------------------------------------------+ | imagecopy_self.py | Copy self published files from the English Wikipedia to | | | Commons. | @@ -193,13 +193,13 @@ | iamgerecat.py | Try to find categories for media on Commons. | +------------------------+---------------------------------------------------------+ | imageuncat.py | Adds uncat template to images without categories at | - | | Commons | + | | Commons. | +------------------------+---------------------------------------------------------+ | isbn.py | Bot to convert all ISBN-10 codes to the ISBN-13 | | | format. | +------------------------+---------------------------------------------------------+ | lonelypages.py | Place a template on pages which are not linked to by | - | | other pages, and are therefore lonely | + | | other pages, and are therefore lonely. | +------------------------+---------------------------------------------------------+ | makecat.py | Given an existing or new category, find pages for that | | | category. | @@ -232,7 +232,7 @@ +------------------------+---------------------------------------------------------+ | surnames_redirects.py | Bot to create redirects based on name order. | +------------------------+---------------------------------------------------------+ - | table2wiki.py | Semi-automatic converting HTML-tables to wiki-tables | + | table2wiki.py | Semi-automatic converting HTML-tables to wiki-tables. | +------------------------+---------------------------------------------------------+ | unlink.py | This bot unlinks a page on every page that links to it. | +------------------------+---------------------------------------------------------+
pywikibot-commits@lists.wikimedia.org