Skip to content

Commit

Permalink
Release 7.3: Support for deprecating positional arguments
Browse files Browse the repository at this point in the history
  • Loading branch information
xolox committed Mar 1, 2020
1 parent b8ca31c commit dd3fff4
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 10 deletions.
32 changes: 24 additions & 8 deletions CHANGELOG.rst
Expand Up @@ -11,6 +11,21 @@ Changelog`_. This project adheres to `semantic versioning`_.
.. _Keep a Changelog: http://keepachangelog.com/
.. _semantic versioning: http://semver.org/

`Release 7.3`_ (2020-03-02)
---------------------------

**Enhancements:**

Added the :func:`humanfriendly.deprecation.deprecate_args()` decorator function
which makes it easy to switch from positional arguments to keyword arguments
without dropping backwards compatibility.

.. note:: I'm still working on the humanfriendly 8.0 release which was going to
break backwards compatibility in several ways if it wasn't for the
tools provided by the new :mod:`humanfriendly.deprecation` module.

.. _Release 7.3: https://github.com/xolox/python-humanfriendly/compare/7.2...7.3

`Release 7.2`_ (2020-03-01)
---------------------------

Expand All @@ -19,14 +34,15 @@ Changelog`_. This project adheres to `semantic versioning`_.
Support for backwards compatible aliases that emit deprecation warnings
(:mod:`humanfriendly.deprecation`).

I'm currently working on several large refactorings that involve moving things
around between modules and dreaded having to extend the existing maze of
(almost but not quite) cyclic import dependencies between modules. This new
functionality will be adopted to untangle the existing maze in the coming
release, which will bump the major version number due to this very large change
in how backwards compatibility is implemented. It is my hope that this new
functionality will prove to be robust enough to unburden me from the less
elegant aspects of preserving backwards compatibility 😁.
.. note:: I'm currently working on several large refactorings that involve
moving things around between modules and dreaded having to extend the
existing maze of (almost but not quite) cyclic import dependencies
between modules. This new functionality will be adopted to untangle
the existing maze in the upcoming humanfriendly 8.0 release, which
bumps the major version number due to this very large change in how
backwards compatibility is implemented. It is my hope that this new
functionality will prove to be robust enough to unburden me from the
less elegant aspects of preserving backwards compatibility 😁.

**Documentation:**

Expand Down
4 changes: 2 additions & 2 deletions humanfriendly/__init__.py
@@ -1,7 +1,7 @@
# Human friendly input/output in Python.
#
# Author: Peter Odding <peter@peterodding.com>
# Last Change: March 1, 2020
# Last Change: March 2, 2020
# URL: https://humanfriendly.readthedocs.io

"""The main module of the `humanfriendly` package."""
Expand Down Expand Up @@ -93,7 +93,7 @@
)

# Semi-standard module versioning.
__version__ = '7.2'
__version__ = '7.3'

# Spinners are redrawn at most this many seconds.
minimum_spinner_interval = 0.2
Expand Down

0 comments on commit dd3fff4

Please sign in to comment.