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

Improved Documentation: Added Advanced options, best practices, troubleshooting tips #1211

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

ThomasOli
Copy link

@ThomasOli ThomasOli commented Sep 25, 2024

Added advanced configuration options, best practices, and troubleshooting tips, users can better leverage Loguru's features and integrate it more effectively into their projects.

Advanced Configuration:

Logging to Multiple Destinations (Sinks): Instructions on how to add multiple sinks to direct logs to various destinations simultaneously.

Custom Log Formats: Guidance on customizing log message formats to include specific information.
Log Rotation and Retention: Details on how to automatically rotate logs and manage retention policies.

Best Practices:

Recommendations on initializing the logger early in the application.
Advice on using context managers for dynamic context.
Tips to avoid common pitfalls like global imports.

Troubleshooting:

Solutions for logs not appearing due to misconfiguration.
Fixes for duplicate logs caused by multiple logger instances.
Performance considerations to prevent logging from slowing down the application.
These additions aim to:

Improve Usability:

Provide deeper insights into Loguru's features, making it easier for users to leverage its full potential.
Assist New Users: Help newcomers integrate Loguru into their projects with clear guidelines and examples.
Support Existing Users: Offer advanced tips and troubleshooting to enhance current implementations.
No existing content has been removed; the new sections build upon the current documentation to offer a more comprehensive guide.

@ThomasOli ThomasOli changed the title Added Advanced options, best practices, troubleshooting tips Improved Documentation: Added Advanced options, best practices, troubleshooting tips Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant