Fix missing deprecation tag #2605
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The pkg.go.dev website shows `DEPRECATED` tags for functions that are marked as deprecated, but the libp2p `DialRanker` function is missing a newline before the `// Deprecated:` line. As a result, even though the function is deprecated, pkg.go.dev does not tag/label it as deprecated. This also affects language servers such as gopls. With gopls enabled in VSCode (using the Go extension), deprecated functions are indicated with a strikethough. This strikethrough does not appear for `DialRanker` because of the missing newline. I published my own module to test this. See: https://pkg.go.dev/github.com/librick/go-deprecated@v0.1.0/deprecated
sukunrt
approved these changes
Oct 16, 2023
sukunrt
pushed a commit
that referenced
this pull request
Oct 18, 2023
Co-authored-by: Eric McDonald <librick@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The pkg.go.dev website shows
DEPRECATEDtags for functions that are marked as deprecated, but the libp2pDialRankerfunction is missing a newline before the// Deprecated:line. As a result, even though the function is deprecated, pkg.go.dev does not tag/label it as deprecated.This also affects language servers such as gopls.
With gopls enabled in VSCode (using the Go extension), deprecated functions are indicated with a strikethough. This strikethrough does not appear for
DialRankerbecause of the missing newline.I published my own module to test this.
See: https://pkg.go.dev/github.com/librick/go-deprecated@v0.1.0/deprecated