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

Advanced Logging Function #26

Merged
merged 5 commits into from
Sep 18, 2023
Merged

Advanced Logging Function #26

merged 5 commits into from
Sep 18, 2023

Conversation

dombean
Copy link
Member

@dombean dombean commented Jul 24, 2023

Description

Added init_logger_advanced function for Enhanced Logging.

The init_logger_advanced function allows us to initialize a logger with custom handlers, log formats, and date formats.

This means that we can create loggers with multiple handlers, such as FileHandler, StreamHandler, etc., and format our logs according to our requirements.

Type of change

  • New feature - non-breaking change

Checklist:

  • I have performed a self-review of my own code.
  • I have commented my code appropriately, focusing on explaining my design decisions (explain why, not how).
  • I have made corresponding changes to the documentation (comments, docstring, etc.. )
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • I have updated the change log.

Peer review

Any new code includes all the following:

  • Documentation: docstrings, comments have been added/ updated.
  • Style guidelines: New code conforms to the project's contribution guidelines.
  • Functionality: The code works as expected, handles expected edge cases and exceptions are handled appropriately.
  • Complexity: The code is not overly complex, logic has been split into appropriately sized functions, etc..
  • Test coverage: Unit tests cover essential functions for a reasonable range of inputs and conditions. Added and existing tests pass on my machine.

Review comments

Suggestions should be tailored to the code that you are reviewing. Provide context.
Be critical and clear, but not mean. Ask questions and set actions.

These might include:
  • bugs that need fixing (does it work as expected? and does it work with other code
    that it is likely to interact with?)
  • alternative methods (could it be written more efficiently or with more clarity?)
  • documentation improvements (does the documentation reflect how the code actually works?)
  • additional tests that should be implemented
    • Do the tests effectively assure that it
      works correctly? Are there additional edge cases/ negative tests to be considered?
  • code style improvements (could the code be written more clearly?)

Further reading: code review best practices

@dombean dombean changed the title Dev advanced logging Advanced Logging Function Jul 24, 2023
@pricemg pricemg merged commit b0f3405 into main Sep 18, 2023
2 checks passed
@pricemg pricemg deleted the dev_advanced_logging branch September 18, 2023 21:41
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.

2 participants