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.

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

docs(logger): rework working with keys doc sections #2696

Merged
merged 3 commits into from
Jun 27, 2024
Merged

docs(logger): rework working with keys doc sections #2696

merged 3 commits into from
Jun 27, 2024

Conversation

dreamorosi
Copy link
Contributor

@dreamorosi dreamorosi commented Jun 26, 2024 •
edited
Loading

Summary

Changes

Please provide a summary of what's being changed

This PR overhauls the section of the Logger docs dedicated to working with keys.

With the changes introduced in #2408 we needed to clarify how the different methods to add keys to logs work and how they interact with the resetKeys() method.

The PR also renames the method from resetState() to resetKeys() for added clarity about its purpose.

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

Issue number: #2667

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.

@dreamorosi dreamorosi self-assigned this Jun 26, 2024
@pull-request-size pull-request-size bot added the size/L PRs between 100-499 LOC label Jun 26, 2024
@boring-cyborg boring-cyborg bot added documentation Improvements or additions to documentation logger This item relates to the Logger Utility labels Jun 27, 2024
@pull-request-size pull-request-size bot added size/XL PRs between 500-999 LOC, often PRs that grown with feedback and removed size/L PRs between 100-499 LOC labels Jun 27, 2024
@boring-cyborg boring-cyborg bot added the tests PRs that add or change tests label Jun 27, 2024
@dreamorosi dreamorosi marked this pull request as ready for review June 27, 2024 09:54
@dreamorosi dreamorosi requested review from a team as code owners June 27, 2024 09:54
@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Jun 27, 2024 •
edited
Loading

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@am29d am29d merged commit d1284bf into main Jun 27, 2024
14 checks passed
@am29d am29d deleted the docs/logger_reset_state branch June 27, 2024 10:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@am29d am29d am29d approved these changes

Assignees

@dreamorosi dreamorosi

Labels
documentation Improvements or additions to documentation logger This item relates to the Logger Utility size/XL PRs between 500-999 LOC, often PRs that grown with feedback tests PRs that add or change tests
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@dreamorosi @am29d