Skip to content

Concise documentation rewrite and a v4 to v5 migration guide #964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mauvilsa merged 3 commits into from
Aug 27, 2026
+1,458 −1,256
Merged

Concise documentation rewrite and a v4 to v5 migration guide #964

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
636efff
Add documentation for migration to v5
mauvilsa Jul 23, 2026
0823cd2
Reword the documentation to be more concise and fix statements that d…
mauvilsa Aug 27, 2026
723516b
Set pull request number
mauvilsa Aug 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,14 @@ Fixed
and a composed one, e.g. ``Optional[Hashable]``, raised ``Unsupported type
hint`` (`#963 <https://github.com/mauvilsa/jsonargparse/pull/963>`__).

Changed
^^^^^^^
- The documentation has been reworded throughout to be shorter and easier to
read, and corrected in the places where it did not describe what the code does
(`#964 <https://github.com/mauvilsa/jsonargparse/pull/964>`__).
- New :ref:`migrate-v5` guide that describes what needs to be changed to migrate
from v4 to v5 (`#964 <https://github.com/mauvilsa/jsonargparse/pull/964>`__).

Deprecated
^^^^^^^^^^
- Values that name a denied import path, e.g. a ``class_path`` of
Expand Down
Loading