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

x/pkgsite: false-positive deprecation warning when the "Deprecated:" sentence does not start a paragraph #46913

Open
bcmills opened this issue Jun 24, 2021 · 1 comment

Comments

@bcmills
Copy link
Member

@bcmills bcmills commented Jun 24, 2021

What is the URL of the page with the issue?

https://beta.pkg.go.dev/go/importer#ForCompiler

What is your user agent?

Mozilla/5.0 (X11; CrOS x86_64 13904.55.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.102 Safari/537.36

Screenshot

image

What did you do?

Attempt to read documentation for importer.ForCompiler.

What did you expect to see?

https://golang.org/wiki/Deprecated says (emphasis mine):

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 line that begins with Deprecated: for importer.ForCompiler is not at the start of its paragraph, so I expect it to apply only to the behavior described in that paragraph and not to the ForCompiler function overall.

What did you see instead?

The entire function is prominently marked as deprecated in the pkgsite UI.

@gopherbot gopherbot added this to the Unreleased milestone Jun 24, 2021
@jba
Copy link
Contributor

@jba jba commented Jun 24, 2021

Whoops!

@jba jba self-assigned this Jun 24, 2021
@jba jba added the NeedsFix label Jun 24, 2021
@jba jba removed this from the Unreleased milestone Jun 24, 2021
@jba jba added this to the pkgsite/unplanned milestone Jun 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants