Skip to content

Commit

Permalink
[doc] update CHANGELOG.rst and ROADMAP
Browse files Browse the repository at this point in the history
Change-Id: I21668ec0b00d3e66212198d7ae6a0d98f10e1c58
  • Loading branch information
xqt committed Jan 4, 2024
1 parent 4eb0813 commit 05f88e5
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
12 changes: 12 additions & 0 deletions ROADMAP.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ Current release
Improvements
^^^^^^^^^^^^

* ``revisions`` parameter of :class:`xmlreader.XmlDump` was introduced to specify parsing method
(:phab:`T340804`)
* Pass global -nolog argument into bot script from wrapper (:phab:`T328900`)
* Add :meth:`site.APISite.ratelimit()<pywikibot.site._apisite.APISite.ratelimit>` method
and :class:`tools.collections.RateLimit` NamedTuple (:phab:`T304808`)
* L10N Updates
Expand All @@ -12,13 +15,21 @@ Improvements
Bugfixes
^^^^^^^^

* Use only ``end`` tags in ElementTree.iterparse in :mod:`xmlreader` module (:phab:`T354095`)
* Suppress error in :meth:`cosmetic_changes.CosmeticChangesToolkit.cleanUpLinks` (:phab:`T337045`)
* :func:`pywikibot.input_choice` validates *default* parameter (:phab:`T353097`)
* Remove typing imports from user-config.py file (:phab:`T352965`)

Breaking changes and code cleanups
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* ``tools.Version`` class was removed; use classes from ``packaging.version`` instead (:phab:`T340640`)
* ``packaging`` package is mandatory; ``importlib_metadata`` package is required for Python 3.7 (:phab:`T340640`)
* ``SelfCallMixin``, ``SelfCallDict`` and ``SelfCallString`` of :mod:`tools` module were removed
* Calling :attr:`site.BaseSite.sitename<pywikibot.site._basesite.BaseSite.sitename>` as a function
is no longer supported
* ``config.register_family_file()`` function was removed
* require ``PyMySQL >= 1.0.0`` if necessary
* ``keys()`` and ``items()`` methods of :class:`data.api.Reques` gives a view instead a list (:phab:`T310953`)
* ``SequenceOutputter.format_list()`` was removed in favour of :attr:`tools.formatter.SequenceOutputter.out` property
* *output* parameter of :class:`bot_choice.OutputProxyOption` (i.e. ``OutputOption`` instance) without *out* property is no longer supported
Expand All @@ -37,6 +48,7 @@ Deprecations
------------

* 9.0.0: ``pywikibot.version.get_toolforge_hostname()`` is deprecated without replacement
* 9.0.0: ``allrevisions`` parameter of :class:`xmlreader.XmpDump` is deprecated, use ``revisions`` instead (:phab:`T340804`)
* 9.0.0: ``iteritems`` method of :class:`data.api.Request` will be removed in favour of ``items``
* 9.0.0: ``SequenceOutputter.output()`` is deprecated in favour of :attr:`tools.formatter.SequenceOutputter.out` property
* 9.0.0: *nullcontext* context manager and *SimpleQueue* queue of :mod:`backports` are derecated
Expand Down
12 changes: 12 additions & 0 deletions scripts/CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,23 @@ Scripts Changelog
9.0.0
-----

category_graph
^^^^^^^^^^^^^^

* Check for ``-from`` option first (:phab:`T354162`)
* Validate file path input (:phab:`T346417`)

category_redirect
^^^^^^^^^^^^^^^^^

* provide category_redirect categories for all WM sites (:phab:`T348914`)

touch
^^^^^

* Use site.ratelimit for bulk purge in PurgeBot


8.5.0
-----

Expand Down

0 comments on commit 05f88e5

Please sign in to comment.