Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/714604 ) Change subject: [doc] Remove trailing whitespaces in doc ...................................................................... [doc] Remove trailing whitespaces in doc Change-Id: I7112cf3783474274d8360e67cca318842d275d93 --- M CODE_OF_CONDUCT.rst M docs/api_ref/pywikibot.tools.rst M docs/credits.rst M docs/faq.rst M docs/glossary.rst M docs/index.rst M docs/library_usage.rst M docs/recipes.rst 8 files changed, 21 insertions(+), 22 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/CODE_OF_CONDUCT.rst b/CODE_OF_CONDUCT.rst index da720ee..cb0641f 100644 --- a/CODE_OF_CONDUCT.rst +++ b/CODE_OF_CONDUCT.rst @@ -1,6 +1,6 @@ Code of Conduct --------------- -The development of this software is covered by a +The development of this software is covered by a `Code of Conduct <https://www.mediawiki.org/wiki/Special:MyLanguage/Code_of_Conduct>`_. diff --git a/docs/api_ref/pywikibot.tools.rst b/docs/api_ref/pywikibot.tools.rst index b3b613e..9f72736 100644 --- a/docs/api_ref/pywikibot.tools.rst +++ b/docs/api_ref/pywikibot.tools.rst @@ -1,6 +1,6 @@ tools package ============= - + .. automodule:: pywikibot.tools tools.chars module diff --git a/docs/credits.rst b/docs/credits.rst index ba94f44..927977d 100644 --- a/docs/credits.rst +++ b/docs/credits.rst @@ -2,4 +2,3 @@ ======= .. include:: ../CREDITS.rst - diff --git a/docs/faq.rst b/docs/faq.rst index 04f0311..0e6432e 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -10,13 +10,13 @@ for wikibase entities and :py:mod:`DequePreloadingGenerator <pywikibot.pagegenerators.DequePreloadingGenerator>` for a :py:mod:`DequeGenerator <pywikibot.tools.DequeGenerator>`. - 3. If you use :py:mod:`GeneratorFactory + 3. If you use :py:mod:`GeneratorFactory <pywikibot.pagegenerators.GeneratorFactory>` with your bot and use its :py:mod:`getCombinedGenerator <pywikibot.pagegenerators.GeneratorFactory.getCombinedGenerator>` method you can set ``preload=True`` to preload page content. This is an alternate to the ``PreloadingGenerator`` function mentioned above. - 4. Use :py:mod:`MySQLPageGenerator + 4. Use :py:mod:`MySQLPageGenerator <pywikibot.pagegenerators.MySQLPageGenerator >` if direct DB access is available and appropriate. See also: `MySQL`_ diff --git a/docs/glossary.rst b/docs/glossary.rst index b6290d1..29f4c2a 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -8,7 +8,7 @@ ``>>>`` The default Python prompt of the interactive Pywikibot shell. Often seen for code examples which can be executed interactively - in the interpreter. The :mod:`pywikibot` module is preloaded. The + in the interpreter. The :mod:`pywikibot` module is preloaded. The :mod:`scripts.shell` script is part of the :mod:`scripts` module. compat @@ -27,7 +27,7 @@ production systems, use :term:`stable` instead. The master branch may have untested features. Use master branch if you want to support development and report undetected problems. - + pwb Can refer to: @@ -41,7 +41,7 @@ convert your old scripts. pywikibot - **Py**\ thon Media\ **Wiki Bot** Framework, a Python library and + **Py**\ thon Media\ **Wiki Bot** Framework, a Python library and collection of scripts that automate work on MediaWiki sites. Originally designed for Wikipedia, it is now used throughout the Wikimedia Foundation's projects and on many other wikis based of @@ -64,14 +64,14 @@ PAWS PAWS (PAWS: A Web Shell) formerly known as *Pywikibot: A Web Shell* - is a Jupyter notebooks deployment hosted by Wikimedia. It has + is a Jupyter notebooks deployment hosted by Wikimedia. It has preinstalled the :term:`stable` release of Pywikibot. Refer: - :manpage:`PAWS` - https://wikitech.wikimedia.org/wiki/PAWS PyPI - The Python Package Index (PyPI), a repository of software for the + The Python Package Index (PyPI), a repository of software for the Python programming language. Pywikibot framework (without scripts) is `published monthly at PyPI <https://pypi.org/project/pywikibot/>`_. \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 334d25b..ab176ec 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,18 +4,18 @@ Welcome! This is the documentation for Pywikibot |release|. **Pywikibot** is a Python library and collection of tools that automate work -on `MediaWiki <https://mediawiki.org>`_ sites. Originally designed for +on `MediaWiki <https://mediawiki.org>`_ sites. Originally designed for Wikipedia, it is now used throughout the Wikimedia Foundation's projects and on many other MediaWiki wikis. The project started in 2003 and is currently on core version |version|. It features full API usage and is up-to-date with new MediaWiki features and -a Pythonic package layout. But it also works with older installations of +a Pythonic package layout. But it also works with older installations of MediaWiki 1.23 or higher. -Pywikibot supports Microsoft Windows, macOS and Linux when used with a +Pywikibot supports Microsoft Windows, macOS and Linux when used with a compatible version of Python. It should also work on any other operating -system that has a compatible version of Python installed. To check +system that has a compatible version of Python installed. To check whether you have Python installed and to find its version, just type ``python`` at the CMD or shell prompt. diff --git a/docs/library_usage.rst b/docs/library_usage.rst index 79d5c25..5d43682 100644 --- a/docs/library_usage.rst +++ b/docs/library_usage.rst @@ -1,7 +1,7 @@ Using pywikibot as library -------------------------- -Pywikibot provides bot classes to develop your own script easily. Here +Pywikibot provides bot classes to develop your own script easily. Here is a minimal example script which shows their usage: .. code-block:: python @@ -40,25 +40,25 @@ if __name == '__main__': main() - + The script can be invoked from commandline like:: python mybot -site:wikipedia:test -page:Sandbox -text:"A text added to the sandbox" - + **Explanations:** :1-3: Import necessary framework code parts -:5: The bot is derived from ExistingPageBot. All pages from generator +:5: The bot is derived from ExistingPageBot. All pages from generator which does not exists are skipped. :7: Every Bot has an *always* option which autoconfirms any changes if set to True. To expand all available options of a bot and set the default values of them, use `update_options` attribute or update - `available_options` like it is shown in BasicBot below. + `available_options` like it is shown in BasicBot below. :12: All changes for each page are made in this method. :14: `currentpage` is the current :py:obj:`pywikibot.Page` object from generator. -:15: All bot options which are passed to the bot class when - instantiating it are accessable via opt attribute. `opt.always`, +:15: All bot options which are passed to the bot class when + instantiating it are accessable via opt attribute. `opt.always`, `opt.text` and `opt.summary` are all available options for this bot class. :16: Save the changes to the live wiki. diff --git a/docs/recipes.rst b/docs/recipes.rst index 2ee6ce9..76e5b84 100644 --- a/docs/recipes.rst +++ b/docs/recipes.rst @@ -10,7 +10,7 @@ See :doc:`library_usage` for more advanced samples. - + **How to get links from summary section of page** -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/714604 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Change-Id: I7112cf3783474274d8360e67cca318842d275d93 Gerrit-Change-Number: 714604 Gerrit-PatchSet: 1 Gerrit-Owner: Xqt &lt;info(a)gno.de&gt; Gerrit-Reviewer: Xqt &lt;info(a)gno.de&gt; Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged