Skip to content

Commit bbe7759

Browse files
authored
Concise documentation rewrite and a v4 to v5 migration guide (#964)
1 parent d950f3f commit bbe7759

5 files changed

Lines changed: 1458 additions & 1256 deletions

File tree

CHANGELOG.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,14 @@ Fixed
7979
and a composed one, e.g. ``Optional[Hashable]``, raised ``Unsupported type
8080
hint`` (`#963 <https://github.com/mauvilsa/jsonargparse/pull/963>`__).
8181

82+
Changed
83+
^^^^^^^
84+
- The documentation has been reworded throughout to be shorter and easier to
85+
read, and corrected in the places where it did not describe what the code does
86+
(`#964 <https://github.com/mauvilsa/jsonargparse/pull/964>`__).
87+
- New :ref:`migrate-v5` guide that describes what needs to be changed to migrate
88+
from v4 to v5 (`#964 <https://github.com/mauvilsa/jsonargparse/pull/964>`__).
89+
8290
Deprecated
8391
^^^^^^^^^^
8492
- Values that name a denied import path, e.g. a ``class_path`` of

0 commit comments

Comments
 (0)