From 00411de4ed290dd05efe9a2cef2054fcdba027b9 Mon Sep 17 00:00:00 2001 From: Leonardo Uieda Date: Tue, 28 Jan 2020 14:25:56 +0000 Subject: [PATCH] Changelog for v1.0.0 (#139) Add a message explaining that 1.0 means a stable API and further backwards incompatible changes will require 2.0 (with backported bug fixes). Fixes #105 --- README.rst | 1 + doc/changes.rst | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+) diff --git a/README.rst b/README.rst index d1128717..390a95ab 100644 --- a/README.rst +++ b/README.rst @@ -220,6 +220,7 @@ Documentation for other versions * `Development `__ (reflects the *master* branch on Github) * `Latest release `__ +* `v1.0.0 `__ * `v0.7.1 `__ * `v0.7.0 `__ * `v0.6.0 `__ diff --git a/doc/changes.rst b/doc/changes.rst index d8a2938f..d1d4de66 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -3,6 +3,41 @@ Changelog ========= +Version 1.0.0 +------------- + +*Released on: 2020/01/28* + +.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3629329.svg + :alt: Digital Object Identifier for the Zenodo archive + :target: https://doi.org/10.5281/zenodo.3629329 + +This release marks the stabilization of the Pooch API. Further changes to the +1.* line will be fully backwards compatible (meaning that updating Pooch should +not break existing code). If there is great need to make backwards incompatible +changes, we will release a 2.* line. In that case, bug fixes will still be +ported to the 1.* line for a period of time. + +Improvements: + +* Allow blank lines in registry files. Previously, they would cause an error. + (`#138 `__) + +**Backwards incompatible changes**: + +* Using Python's ``logging`` module to instead of ``warnings`` to inform users + of download, update, and decompression/unpacking actions. This allows + messages to be logged with different priorities and the user filter out log + messages or silence Pooch entirely. Introduces the function + ``pooch.get_logger`` to access the ``logging`` object used by Pooch. **Users + who relied on Pooch issuing warnings will need to update to capturing logs + instead.** All other parts of the API remain unchanged. + (`#115 `__) + +This release contains contributions from: + +* Daniel Shapero + Version 0.7.2 -------------