Xqt submitted this change.

View Change

[doc] Update documentation

- update ROADMAP.rst
- update CHANGELOG.md
- add a warning to OptionHandler description
- add additional documentation to IndexPage._get_prp_index_pagelist

Change-Id: I8067a45d5f9250080f936001143289d2bfb2b7f5
---
M ROADMAP.rst
M pywikibot/bot.py
M pywikibot/proofreadpage.py
M scripts/CHANGELOG.md
4 files changed, 23 insertions(+), 1 deletion(-)

diff --git a/ROADMAP.rst b/ROADMAP.rst
index eeace9a..37dd271 100644
--- a/ROADMAP.rst
+++ b/ROADMAP.rst
@@ -1,6 +1,10 @@
 Current release 7.3.0
 ^^^^^^^^^^^^^^^^^^^^^
 
+* use linktrail via siteinfo and remove `update_linkrtrails` maintenance script
+* Print counter statistic for all counters (:phab:`T307834`)
+* Use proofreadpagesinindex query module
+* Prioritize -namespaces options in `pagegenerators.handle_args` (:phab:`T222519`)
 * Remove `ThreadList.stop_all()` method (:phab:`T307830`)
 * L10N updates
 * Improve get_charset_from_content_type function (:phab:`T307760`)
diff --git a/pywikibot/bot.py b/pywikibot/bot.py
index d22be16..70e845d 100644
--- a/pywikibot/bot.py
+++ b/pywikibot/bot.py
@@ -1172,6 +1172,9 @@
 
     >>> 'Option opt.{foo} is {bar}'.format_map(bot.opt)
     'Option opt.bar is 4711'
+
+    .. warning:: You must not access bot options as an attribute if the
+       keyword is a :python:`dict method<library/stdtypes.html#dict.clear>`.
     """
 
     available_options = {}  # type: Dict[str, Any]
diff --git a/pywikibot/proofreadpage.py b/pywikibot/proofreadpage.py
index 758ed41..8378c4f 100644
--- a/pywikibot/proofreadpage.py
+++ b/pywikibot/proofreadpage.py
@@ -832,7 +832,16 @@
         self._cached = False
 
     def _get_prp_index_pagelist(self):
-        """Get all pages in an IndexPage page list."""
+        """Get all pages in an IndexPage page list.
+
+        .. note:: This method is called by initializer and should not be used.
+
+        .. seealso::
+           `ProofreadPage Index Pagination API
+           <https://www.mediawiki.org/wiki/Extension:ProofreadPage/Index_pagination_API>`_
+
+        :meta public:
+        """
         site = self.site
         ppi_args = {}
         if hasattr(self, '_pageid'):
diff --git a/scripts/CHANGELOG.md b/scripts/CHANGELOG.md
index 7c209ab..b887002 100644
--- a/scripts/CHANGELOG.md
+++ b/scripts/CHANGELOG.md
@@ -3,6 +3,12 @@
 ## 7.3.0
 *In development*
 
+### general
+* Call ExistingPageBot.skip_page() first (:phab:`T86491`)
+
+### replace
+* A -nopreload option was added
+
 ### weblinkchecker
 * Do not kill threads after generator is exhausted (:phab:`T113139`)
 * Use Page.extlinks() to get external links (:phab:`T60812`)

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