Skip to content

fix: mark functions as deprecated with doc comment#491

Merged
johnweldon merged 1 commit intogo-ldap:masterfrom
donatello:deprecated
Mar 22, 2024
Merged

fix: mark functions as deprecated with doc comment#491
johnweldon merged 1 commit intogo-ldap:masterfrom
donatello:deprecated

Conversation

@donatello
Copy link
Contributor

Refer to https://go.dev/wiki/Deprecated

The right way to mark a function as deprecated is to use Deprecated: as the beginning of a doc comment paragraph.

This ensures that various tools (such as static checks) pick up the deprecation information.

Refer to https://go.dev/wiki/Deprecated

The right way to mark a function as deprecated is to use `Deprecated:`
as the beginning of a doc comment paragraph.

This ensures that various tools (such as static checks) pick up the
deprecation information.
Copy link
Member

@johnweldon johnweldon left a comment

Choose a reason for hiding this comment

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

LGTM

@johnweldon
Copy link
Member

Thank you @donatello

@johnweldon johnweldon merged commit d13d063 into go-ldap:master Mar 22, 2024
@donatello donatello deleted the deprecated branch March 22, 2024 19:53
gustavoluvizotto pushed a commit to gustavoluvizotto/ldap-fork that referenced this pull request Apr 11, 2024
Refer to https://go.dev/wiki/Deprecated

The right way to mark a function as deprecated is to use `Deprecated:`
as the beginning of a doc comment paragraph.

This ensures that various tools (such as static checks) pick up the
deprecation information.
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