orbit-oss/flask
4
4
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

minor rewording of get_json documentation for clarity (#1781)

Browse source
This commit is contained in:
Miguel Grinberg 2016-05-04 06:46:49 -07:00 • committed by David Lord
parent 317d60307d
commit de25e98f91
1 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

11
flask/wrappers.py
View file

@ -123,11 +123,12 @@ class Request(RequestBase):
return False
def get_json(self, force=False, silent=False, cache=True):
"""Parses the incoming JSON request data and returns it. If
parsing fails the :meth:`on_json_loading_failed` method on the
request object will be invoked. By default this function will
only load the json data if the mimetype is :mimetype:`application/json`
but this can be overridden by the `force` parameter.
"""Parses the incoming JSON request data and returns it. By default
this function will return ``None`` if the mimetype is not
:mimetype:`application/json` but this can be overridden by the
``force`` parameter. If parsing fails the
:meth:`on_json_loading_failed` method on the request object will be
invoked.
:param force: if set to ``True`` the mimetype is ignored.
:param silent: if set to ``True`` this method will fail silently