@@ -15,16 +15,16 @@ def _generate_error_dict(error: _BaseFlaskException) -> Dict[str, Any]:
1515 :type error: _BaseFlaskException
1616
1717 :return: Returns a dict containing a json representation of the error
18- :rtype: dict
18+ :rtype: Dict[str, Any]
1919
2020 :Example:
2121
2222 .. code-block:: python
2323
2424 from flask_utils import ConflictError # or any other error
25- from flask_utils.errors._error_template import _generate_error_json
25+ from flask_utils.errors._error_template import _generate_error_dict
2626
27- json = _generate_error_json (error)
27+ json = _generate_error_dict (error)
2828 # Sample output:
2929 # {
3030 # "success": False,
@@ -67,7 +67,7 @@ def _generate_error_response(error: _BaseFlaskException) -> Response:
6767 .. code-block:: python
6868
6969 from flask_utils.errors import _BaseFlaskException
70- from flask_utils.errors._error_template import _generate_error_json
70+ from flask_utils.errors._error_template import _generate_error_response
7171
7272 class MyError(_BaseFlaskException):
7373 self.name = "MyError"
@@ -77,12 +77,12 @@ class MyError(_BaseFlaskException):
7777
7878 error = MyError("This is an error", "This is the solution")
7979
80- json = _generate_error_json (error, 666)
80+ response = _generate_error_response (error, 666)
8181
8282 .. versionchanged:: 0.8.0
83- This function was renamed from ``generate_error_json `` to ``_generate_error_response``.
83+ This function was renamed from ``_generate_error_json `` to ``_generate_error_response``.
8484 It now returns a ``flask.Response`` object, calling
85- :func:`~flask_utils.errors._error_template._generate_error_json ` to generate the json .
85+ :func:`~flask_utils.errors._error_template._generate_error_dict ` to generate the dict that will be returned .
8686
8787 .. versionadded:: 0.1.0
8888 """
0 commit comments