Skip to content

Commit

Permalink
Docs: Removed hard coded links
Browse files Browse the repository at this point in the history
  • Loading branch information
Mews committed Jun 11, 2024
1 parent 2ab6faa commit b2a4ddf
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Custom exceptions
-----------------

.. warning:: For any of these errors to work, you need to register the error handlers in your Flask app.
To do this, you can call :meth:`flask_utils.errors.register_error_handlers` with your Flask app as an argument.
To do this, you can call :meth:`register_error_handlers` with your Flask app as an argument.

.. code-block:: python
Expand Down
2 changes: 1 addition & 1 deletion flask_utils/decorators.py
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ def validate_params(
and the values are the expected types.
:param allow_empty: Allow empty values for parameters. Defaults to False.
:raises flask_utils.errors.badrequest.BadRequestError: If the JSON body is malformed,
:raises BadRequestError: If the JSON body is malformed,
the Content-Type header is missing or incorrect, required parameters are missing,
or parameters are of the wrong type.
Expand Down
4 changes: 2 additions & 2 deletions flask_utils/errors/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ def _register_error_handlers(application: Flask) -> None:
.. versionchanged:: 0.5.0
Made the function private. If you want to register the custom error handlers, you need to
pass `register_error_handlers=True` to the :class:`flask_utils.extension.FlaskUtils` class
or to :meth:`flask_utils.extension.FlaskUtils.init_app`
pass `register_error_handlers=True` to the :class:`FlaskUtils` class
or to :meth:`FlaskUtils.init_app`
.. code-block:: python
Expand Down

0 comments on commit b2a4ddf

Please sign in to comment.