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

Clean up docs about error handling #3573

Closed
davidism opened this issue Apr 14, 2020 · 4 comments · Fixed by #3594
Closed

Clean up docs about error handling #3573

davidism opened this issue Apr 14, 2020 · 4 comments · Fixed by #3594
Labels

Comments

@davidism
Copy link
Member

davidism commented Apr 14, 2020

There are many pages in the docs that have different overlapping information about error handlers:

These need to be consolidated, probably into the errorhandling.rst page, with a link to the blueprints page section for blueprint-specific information.

Also, in #3572 @mikeckennedy brought to our attention that the docs about 404 and 500 handlers for blueprints needs clarification with better examples and explanation of why they don't work in all cases.

@davidism davidism added the docs label Apr 14, 2020
@jackwardell
Copy link
Contributor

would be happy to have a crack at this if desired

@davidism
Copy link
Member Author

No need to ask, if there's no PR linked to an issue just go for it!

@jackwardell
Copy link
Contributor

is there a reason why register_error_handler has an underscore between "error" and "handler" when errorhandler does not?

@davidism
Copy link
Member Author

It came later and I wanted to use snake case going forward.

jackwardell added a commit to jackwardell/flask that referenced this issue May 2, 2020
Removing apierrors.rst and errorpages.rst from patterns and integrating the content into errorhandling.rst alterations and extra content.
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 14, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants