search

Seluj78 / flask-utils

Various Flask utilities that I find useful in my projects
GNU General Public License v3.0
2 stars 1 forks source link

Refactor documentation to avoid full links #10

Closed Seluj78 closed 1 month ago

Seluj78 commented 1 month ago

Refactor documentation to avoid full links in docs (have BadRequestError instead of flask_utils.errors.BadRequestError).

For example https://flask-utils.readthedocs.io/en/latest/api.html#custom-exceptions

Screenshot 2024-06-10 at 14 50 02
Mews commented 1 month ago

In your example, would you rather flask_utils.errors.BadRequestError become flask_utils.BadRequestError or just BadRequestError? If it's the latter this is a rather easy fix, and I can submit a pr right away. If it's the former it is also very doable.

Seluj78 commented 1 month ago

Yeah I want to have the link to just be BadRequestError using :meth: or :func: but I wasn't able to do it and I am not knowledgable enough in Sphinx

Mews commented 1 month ago

Ok so just to make sure you want to change this image To this image

Seluj78 commented 1 month ago

That's totally correct !

Mews commented 1 month ago

Alright I think that's a single line of code lol But I'll open the pr anyway