Hide full links in docs #29
Conversation
WalkthroughThis update refines the documentation and codebase of a Flask application by replacing full path references with relative paths for better readability. It includes changes to the Changes
Assessment against linked issues
Poem
Warning Review ran into problemsProblems (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
|
Oh wow I didn't think it would be that easy, nice one ! 🙌 I have found some full links still, they might be due to me hard-coding them, but here are the links to the preview build of your PR where I found them, ideally if you could fix those as well in the same PR it would be amazing ! https://flask-utils--29.org.readthedocs.build/en/29/api.html#custom-exceptions https://flask-utils--29.org.readthedocs.build/en/29/api.html#module-flask_utils.decorators |
|
Oops yeah I didn't realise that, I fixed that now |
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (2)
flask_utils/decorators.py (2)
Line range hint
247-247: Improve exception handling by specifying the cause of the raised exceptions.- except BadRequest: - raise BadRequestError("The Json Body is malformed.") + except BadRequest as err: + raise BadRequestError("The Json Body is malformed.") from err - except UnsupportedMediaType: - raise BadRequestError( + except UnsupportedMediaType as err: + raise BadRequestError( "The Content-Type header is missing or is not set to application/json, or the JSON body is missing." ) from errAlso applies to: 249-251
Line range hint
92-94: Simplify the nestedifstatements to enhance readability and maintainability.- if value in [None, "", [], {}]: - # Check if type is explicitly Optional or allow_empty is True - if _is_optional(type_hint) or allow_empty: - return True + if value in [None, "", [], {}] and (_is_optional(type_hint) or allow_empty): + return True
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- docs/source/api.rst (1 hunks)
- flask_utils/decorators.py (1 hunks)
- flask_utils/errors/init.py (1 hunks)
Files skipped from review due to trivial changes (2)
- docs/source/api.rst
- flask_utils/errors/init.py
Additional context used
Ruff
flask_utils/decorators.py
92-94: Use a single
ifstatement instead of nestedifstatements (SIM102)
247-247: Within an
exceptclause, raise exceptions withraise ... from errorraise ... from Noneto distinguish them from errors in exception handling (B904)
249-251: Within an
exceptclause, raise exceptions withraise ... from errorraise ... from Noneto distinguish them from errors in exception handling (B904)
Additional comments not posted (1)
flask_utils/decorators.py (1)
189-189: Update the exception reference in the docstring to match the simplified usage.
|
Is it? I counted 69 characters but I'll shorten it |
|
Also |
Mews
force-pushed
the
docs-hide-full-links
branch
from
c0cb9f6
to
ec00e84
Compare
|
Oh mb where are they, I can't see the logs |
No worries haha, that's why I recommend you install
|
|
I had it installed but I cleared my venv and I forgot :/ I'll fix it now |
|
Don't forget to do |
|
Done! |
|
Weirdly, your commit still isn't passing. Do you want to try again or do you want me to do it ? |
|
The commit message? Which one is failing I can change it again |
|
This one weirdly
|
|
Mhm that's definitely less than 72 characters |
|
Want me to try ? Don't touch your branch I'll try and fix it if you're ok with it |
|
Okay 👍 |
Seluj78
force-pushed
the
docs-hide-full-links
branch
from
6e5fefc
to
c3899dd
Compare
|
Hmm still trying to figure it out |
This is more robust than letting sphinx look for FlaskUtils or init_app and create a link to the first thing it finds
Seluj78
force-pushed
the
docs-hide-full-links
branch
from
c3899dd
to
cdc5dbe
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (2)
flask_utils/decorators.py (2)
Line range hint
92-94: Refactor to use a singleifstatement.- if not data: - raise BadRequestError("Missing json body.") - if not isinstance(data, dict): - raise BadRequestError("JSON body must be a dict") + if not data or not isinstance(data, dict): + raise BadRequestError("Missing or invalid JSON body.")This refactoring reduces the complexity of the code by combining related conditions, improving readability and maintainability.
Line range hint
247-247: Use thefromkeyword in exception handling.- except BadRequest: - raise BadRequestError("The Json Body is malformed.") + except BadRequest as err: + raise BadRequestError("The Json Body is malformed.") from err - except UnsupportedMediaType: - raise BadRequestError( - "The Content-Type header is missing or is not set to application/json, or the JSON body is missing." - ) + except UnsupportedMediaType as err: + raise BadRequestError( + "The Content-Type header is missing or is not set to application/json, or the JSON body is missing." + ) from errUsing
from errprovides a clearer traceback and helps in debugging by linking the new exception to the original cause.Also applies to: 249-251
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- docs/source/api.rst (1 hunks)
- docs/source/conf.py (1 hunks)
- flask_utils/decorators.py (1 hunks)
- flask_utils/errors/init.py (1 hunks)
Files skipped from review as they are similar to previous changes (3)
- docs/source/api.rst
- docs/source/conf.py
- flask_utils/errors/init.py
Additional context used
Ruff
flask_utils/decorators.py
92-94: Use a single
ifstatement instead of nestedifstatements (SIM102)
247-247: Within an
exceptclause, raise exceptions withraise ... from errorraise ... from Noneto distinguish them from errors in exception handling (B904)
249-251: Within an
exceptclause, raise exceptions withraise ... from errorraise ... from Noneto distinguish them from errors in exception handling (B904)
Additional comments not posted (1)
flask_utils/decorators.py (1)
189-189: Update the docstring to reflect the correct exception.- from flask_utils.errors.badrequest import BadRequestError + from flask_utils.errors import BadRequestErrorThis change aligns the import statement in the docstring with the actual import at the top of the file, ensuring consistency and correctness.
Likely invalid or redundant comment.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- docs/source/api.rst (1 hunks)
- docs/source/conf.py (1 hunks)
- flask_utils/decorators.py (1 hunks)
- flask_utils/errors/init.py (1 hunks)
Files skipped from review as they are similar to previous changes (4)
- docs/source/api.rst
- docs/source/conf.py
- flask_utils/decorators.py
- flask_utils/errors/init.py
|
Here I fixed it by force. I removed the |
|
Thank you for the PR @Mews ! 😍 |
Description
Modified the sphinx config file to not include full paths when building the docs
Related Issue
Checklist
Type of change
📚 Documentation preview 📚: https://flask-utils--29.org.readthedocs.build/en/29/
Summary by CodeRabbit
Documentation
FlaskUtilsclass methods for error handling.add_module_names = Falsefor EPUB output inconf.py.validate_paramsfunction's docstring.Refactor
FlaskUtilsclass and methods for improved readability and maintainability.