Skip to content

Commit f1e876e

Browse files
committed
Add an upgrading doc to help users switch to 6.0
The doc covers several issues, and explicitly is meant to address and resolve #485. The doc is modeled on the marshmallow upgrading doc, and documents every backwards incompatible change which was made in 6.0, along with an example of impacted code and a rewrite which restores equivalent or near-equivalent behavior. The doc mostly steers clear of trying to explain the decisions made, but it does provide some context, especially at the beginning when we have to show major signature changes in `use_args`/`use_kwargs`/`parse`. Most of the suggested rewrites are simple, but a couple -- most notably the UnpackingDelimitedListSchema case -- are ideas which might be non-obvious to users. Except when documenting specific changes to `parse` and related functions, everything is using `locations=("query",)` to specify "query params only" in the 5.x version of the code. That way, the translation to 6.x remains very simple in these cases.
1 parent 6d72cb1 commit f1e876e

File tree

2 files changed

+456
-0
lines changed

2 files changed

+456
-0
lines changed

docs/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@ Release v\ |version|. (:doc:`Changelog <changelog>`)
66

77
webargs is a Python library for parsing and validating HTTP request objects, with built-in support for popular web frameworks, including Flask, Django, Bottle, Tornado, Pyramid, webapp2, Falcon, and aiohttp.
88

9+
Upgrading from an older version?
10+
--------------------------------
11+
12+
See the :doc:`Upgrading to Newer Releases <upgrading>` page for notes on getting your code up-to-date with the latest version.
13+
14+
15+
Usage and Simple Examples
16+
-------------------------
917

1018
.. code-block:: python
1119
@@ -109,5 +117,6 @@ Project Info
109117

110118
license
111119
changelog
120+
upgrading
112121
authors
113122
contributing

0 commit comments

Comments
 (0)