This PR introduces a new section to the ASGI tutorial in the Falcon documentation, aimed at providing developers with clear instructions on setting up and utilizing logging for debugging ASGI applications. The added content outlines the steps to configure basic logging using Python's built-in logging module, offering examples of how to log informational, warning, and error messages effectively.
Related Issues
Pull Request Checklist
This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. But please read our contribution guide at least once; it will save you a few review cycles!
If an item doesn't apply to your pull request, check it anyway to make it apparent that there's nothing to do.
[ ] Applied changes to both WSGI and ASGI code paths and interfaces (where applicable).
[ ] Added tests for changed code.
[ ] Prefixed code comments with GitHub nick and an appropriate prefix.
[ ] Coding style is consistent with the rest of the framework.
[ ] Updated documentation for changed code.
[ ] Added docstrings for any new classes, functions, or modules.
[ ] Updated docstrings for any modifications to existing code.
[ ] Updated both WSGI and ASGI docs (where applicable).
[ ] Added references to new classes, functions, or modules to the relevant RST file under docs/.
[ ] Updated all relevant supporting documentation files under docs/.
[ ] A copyright notice is included at the top of any new modules (using your own name or the name of your organization).
[ ] Changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecateddirectives.
[ ] Changes (and possible deprecations) have towncrier news fragments under docs/_newsfragments/, with the file name format {issue_number}.{fragment_type}.rst. (Run towncrier --draft to ensure it renders correctly.)
If you have any questions to any of the points above, just submit and ask! This checklist is here to help you, not to deter you from contributing!
Summary of Changes
This PR introduces a new section to the ASGI tutorial in the Falcon documentation, aimed at providing developers with clear instructions on setting up and utilizing logging for debugging ASGI applications. The added content outlines the steps to configure basic logging using Python's built-in logging module, offering examples of how to log informational, warning, and error messages effectively.
Related Issues
Pull Request Checklist
This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. But please read our contribution guide at least once; it will save you a few review cycles!
If an item doesn't apply to your pull request, check it anyway to make it apparent that there's nothing to do.
docs/
.docs/
.versionadded
,versionchanged
, ordeprecated
directives.docs/_newsfragments/
, with the file name format{issue_number}.{fragment_type}.rst
. (Runtowncrier --draft
to ensure it renders correctly.)If you have any questions to any of the points above, just submit and ask! This checklist is here to help you, not to deter you from contributing!
PR template inspired by the attrs project.