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

docs: fix env variable name in logEventIfEnabled() docstring #3197

Merged

Conversation

kevinpeno
Copy link
Contributor

Summary

fix typo for env variable POWERTOOLS_LOGGER_LOG_EVENT in logger.logEventIfEnabled

Changes

Please provide a summary of what's being changed

Fixed env details on typedoc for logger.logEventIfEnabled from POWERTOOLS_LOG_EVENT to POWERTOOLS_LOGGER_LOG_EVENT per discussion in #3196

Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

Issue number: #3196


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

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@kevinpeno kevinpeno requested review from a team as code owners October 13, 2024 17:52
@boring-cyborg boring-cyborg bot added the logger This item relates to the Logger Utility label Oct 13, 2024
@pull-request-size pull-request-size bot added the size/XS PR between 0-9 LOC label Oct 13, 2024
Copy link

boring-cyborg bot commented Oct 13, 2024

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
In the meantime, check out the #typescript channel on our Powertools for AWS Lambda Discord: Invite link

Copy link

@kevinpeno kevinpeno changed the title fix(docs): fix typo for env variable on logger.logEventIfEnabled docs: fix env variable name in logEventIfEnabled() docstring Oct 13, 2024
@github-actions github-actions bot added the bug Something isn't working label Oct 13, 2024
@dreamorosi dreamorosi added documentation Improvements or additions to documentation and removed bug Something isn't working labels Oct 13, 2024
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 @kevinpeno, thank you so much for the quick PR in response to the issue.

Before I merge this, could you please leave a comment under the issue so I can assign it to you? It's just for tracking purposes and GitHub doesn't allow me to assign issues to external contributors unless they have interacted with the issue.

Thank you again for helping improving the project!

@dreamorosi dreamorosi linked an issue Oct 13, 2024 that may be closed by this pull request
@kevinpeno
Copy link
Contributor Author

No problem! I was looking for some easy wins this morning and came across that issue. Glad I could help!

@dreamorosi dreamorosi merged commit 16adea6 into aws-powertools:main Oct 14, 2024
31 checks passed
Copy link

boring-cyborg bot commented Oct 14, 2024

Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!

@kevinpeno kevinpeno deleted the 3196-fix-typedoc-logEventIfEnabled branch October 14, 2024 13:53
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 logger This item relates to the Logger Utility size/XS PR between 0-9 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: fix env variable name in logEventIfEnabled() docstring
2 participants