Skip to content

Commit

Permalink
Fix Parser.parse docstring for 'location'
Browse files Browse the repository at this point in the history
Refer to the `__location_map__` attribute, and expand the list of
supported locations to be complete (add `query` and `json_or_form`).
  • Loading branch information
sirosen committed Dec 16, 2019
1 parent 4b12543 commit 007ad84
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/webargs/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -240,8 +240,9 @@ def parse(
which accepts a request and returns a `marshmallow.Schema`.
:param req: The request object to parse.
:param str location: Where on the request to load values.
Can be one of ``('json', 'querystring', 'form', 'headers', 'cookies',
'files')``.
Can be any of the values in :py:attr:`~__location_map__`. By
default, that means one of ``('json', 'query', 'querystring',
'form', 'headers', 'cookies', 'files', 'json_or_form')``.
:param callable validate: Validation function or list of validation functions
that receives the dictionary of parsed arguments. Validator either returns a
boolean or raises a :exc:`ValidationError`.
Expand Down

0 comments on commit 007ad84

Please sign in to comment.