Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit af32e5b

Browse files
committed
doc: Fixed small error in documentation for register_error_handlers
1 parent f1d9c31 commit af32e5b

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

flask_utils/errors/__init__.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,23 @@ def _register_error_handlers(application: Flask) -> None:
2727
2828
.. versionchanged:: 0.5.0
2929
Made the function private. If you want to register the custom error handlers, you need to
30-
pass ``register_error_handlers=True`` to the :class:`~flask_utils.extension.FlaskUtils` class
31-
or to :meth:`~flask_utils.extension.FlaskUtils.init_app`
30+
pass ``register_error_handlers=True`` to the :class:`~flask_utils.extension.FlaskUtils` class
31+
or to :meth:`~flask_utils.extension.FlaskUtils.init_app`
32+
33+
register_error_handlers is ``True`` by default.
3234
3335
.. code-block:: python
3436
3537
from flask import Flask
3638
from flask_utils import FlaskUtils
3739
3840
app = Flask(__name__)
39-
utils = FlaskUtils(app)
41+
utils = FlaskUtils(app, register_error_handlers=True)
4042
4143
# OR
4244
4345
utils = FlaskUtils()
44-
utils.init_app(app)
46+
utils.init_app(app, register_error_handlers=True)
4547
4648
.. versionadded:: 0.1.0
4749
"""

flask_utils/errors/_error_template.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -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

Comments
 (0)