Skip to content

docs(logger): update child logger docs section and snippets #1286

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Feb 13, 2023
Merged

docs(logger): update child logger docs section and snippets #1286

merged 4 commits into from
Feb 13, 2023

Conversation

shdq
Copy link
Contributor

@shdq shdq commented Feb 13, 2023 •
edited
Loading

Description of your changes

This PR is intended to improve docs for child loggers (createChild method). It is the last part of improving the child logger implementation, unit tests, and documentation. In the first PR #1178 child Logger implementation was changed, and new tests were introduced, in this PR #1264 implementation was improved, and new tests were introduced that cover all attributes inherited from a parent logger.

How to verify this change

Related issues, RFCs

Issue number: #483

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding changes to the examples
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published
  • The PR title follows the conventional commit semantics

Breaking change checklist

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@pull-request-size pull-request-size bot added the size/S PR between 10-29 LOC label Feb 13, 2023
@shdq shdq changed the title docs(logger): update docs and snippets about child logger docs(logger): update child logger docs section and snippets Feb 13, 2023
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 13, 2023
dreamorosi
dreamorosi reviewed Feb 13, 2023
View reviewed changes
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR!

Minor suggestions/rewording on a couple of sentences.

@dreamorosi dreamorosi linked an issue Feb 13, 2023 that may be closed by this pull request
Maintenance: add tests for child logger attributes #483
Closed
4 tasks
shdq and others added 2 commits February 13, 2023 16:23
@shdq @dreamorosi
Update docs/core/logger.md
f31a3f0 
Co-authored-by: Andrea Amorosi <[email protected]>
@shdq @dreamorosi
Update docs/core/logger.md
f924d1c 
Co-authored-by: Andrea Amorosi <[email protected]>
@shdq
Copy link
Contributor Author

shdq commented Feb 13, 2023

Once a child logger is created, the logger and its parent will act as separate instances of the Logger class, and as such any change to one won't be applied to the other.

I like this sentence! Thanks for the suggestions!

@dreamorosi dreamorosi self-requested a review February 13, 2023 13:41
dreamorosi
dreamorosi approved these changes Feb 13, 2023
View reviewed changes
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Thank you for the help on this 🎉

@dreamorosi dreamorosi merged commit 2fb3688 into aws-powertools:main Feb 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dreamorosi dreamorosi dreamorosi approved these changes

Assignees

@shdq shdq

Labels
documentation Improvements or additions to documentation size/S PR between 10-29 LOC
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Maintenance: add tests for child logger attributes
2 participants
@shdq @dreamorosi