Skip to content

docs: update logger.md #1048

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

Merged
merged 1 commit into from
Aug 10, 2022
Merged

docs: update logger.md #1048

merged 1 commit into from
Aug 10, 2022

Conversation

tsop14
Copy link
Contributor

@tsop14 tsop14 commented Aug 10, 2022

Description of your changes

Logger documentation update. Reading docs for the first time, this library looks great (looking forward to trying it out) but I believe a few of the log output examples are out of sync with the handler.ts code.

How to verify this change

Run code in handler.ts and verify log output matches updated Example CloudWatch Logs excerpt

Related issues, RFCs

Issue number: #1049

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 in downstream module
  • 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.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Aug 10, 2022
@dreamorosi dreamorosi linked an issue Aug 10, 2022 that may be closed by this pull request
Copy link
Contributor

@saragerion saragerion left a comment

Choose a reason for hiding this comment

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

Thanks so much @tsop14 for your kind words and taking the time to make this library better ❤️

Glad to have you as new first time contributor! 🚀

@saragerion saragerion requested a review from flochaz August 10, 2022 16:08
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.

Hi @tsop14 thank you for taking the time to open a PR in this repo, appreciate your time.

Leaving here the screenshots of the rendered docs for future reference of the changes:
image
image
image

@saragerion saragerion merged commit d48c1f8 into aws-powertools:main Aug 10, 2022
@saragerion
Copy link
Contributor

Note, the preview of the changes is visible here:
https://awslabs.github.io/aws-lambda-powertools-typescript/dev/core/logger/

It will be available in the "latest" version with the next release.

@tsop14 tsop14 deleted the patch-1 branch August 10, 2022 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: examples/outputs need updating
3 participants