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

chore: fix deprecated comment on WithLogger #22

Merged
merged 1 commit into from
Apr 9, 2024
Merged

chore: fix deprecated comment on WithLogger #22

merged 1 commit into from
Apr 9, 2024

Conversation

shota3506
Copy link
Contributor

fix deprecated comment on WithLogger.

Deprecated comment should be the beginning of a paragraph.

To signal that an identifier should not be used, add a paragraph to its doc comment that begins with Deprecated: followed by some information about the deprecation, and a recommendation on what to use instead, if applicable. The paragraph does not have to be the last paragraph in the doc comment.

https://go.dev/wiki/Deprecated

I confirmed that staticcheck doesn't warn on the use of WithLogger method right now.
This change enable linters to find out the deprecated method usage.

@orandin orandin merged commit d0ef590 into orandin:master Apr 9, 2024
1 check passed
@orandin
Copy link
Owner

orandin commented Apr 9, 2024

Thank you @shota3506!

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