Skip to content

[Enhancement Request] - [Add Logging Instructions Using rich to the Developer Style Guide] #1204

@behnazh-w

Description

@behnazh-w

Description

It would be helpful to include clear logging instructions in the developer documentation for Macaron, specifically using the new macaron.console's access_handler, which uses the rich library. Adding this guidance will ensure consistent logging practices across the codebase and make it easier for contributors to implement well-formatted and readable logs.

Proposed Feature

Please add a section to docs/source/pages/developers_guide/style_guide.rst that covers best practices for logging with the rich library. The section should include:

  • A brief overview of why we use rich for logging
  • Instructions on how to import and use access_handler in Macaron
  • Example code snippets demonstrating standard logging patterns (e.g., info, warning, error messages)
  • Any guidelines for formatting log output

Use Case

When new contributors join the project or when existing contributors add or update code, they can refer to this documentation for standardized logging practices. This will improve code readability, ease debugging, and provide a consistent user experience in the logs.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementEnhancement of a feature

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions