Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: refactor exception usage #3823

Merged
merged 6 commits into from
Oct 23, 2024
Merged

docs: refactor exception usage #3823

merged 6 commits into from
Oct 23, 2024

Conversation

sobolevn
Copy link
Member

I made quite a lot of changes:

  1. I replaced :doc: with :ref: since it is more reliable
  2. I replaced things like
:class:`HTTPException <.exceptions.http_exceptions.HTTPException>`

to be just

:class:`~litestar.exceptions.http_exceptions.HTTPException`

Because it the same thing

  1. I changed a lot of wordings to be more readable (for my taste, please, suggest better ones)
  2. I changed .. :currentmodule:: litestar.exceptions.http_exceptions in two ways: removed py, because it is the default role, and reset it after the table. It can be very hard to find why something does not work in the future, when you manipulate current module without reseting it properly
  3. I moved exception in the table to be ordered by error code, it used to be:
Снимок экрана 2024-10-17 в 10 29 41 6. I moved the paragraph about handling exceptions in different layers of the app after we introduce the layers concept :)

@sobolevn sobolevn requested review from a team as code owners October 17, 2024 07:30
@github-actions github-actions bot added area/docs This PR involves changes to the documentation size: small type/docs pr/external Triage Required 🏥 This requires triage labels Oct 17, 2024
docs/usage/exceptions.rst Outdated Show resolved Hide resolved
docs/usage/exceptions.rst Outdated Show resolved Hide resolved
@provinzkraut provinzkraut enabled auto-merge (squash) October 23, 2024 09:40
@provinzkraut provinzkraut merged commit ffcecb1 into main Oct 23, 2024
24 checks passed
@provinzkraut provinzkraut deleted the exception-usage-docs branch October 23, 2024 11:38
Copy link

sonarcloud bot commented Oct 23, 2024

Copy link

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/3823

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs This PR involves changes to the documentation pr/external pr/internal size: small Triage Required 🏥 This requires triage type/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants