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/tools/go/pointer: explain deprecation #70984

Open
dannyc-grafana opened this issue Dec 24, 2024 · 0 comments
Open

x/tools/go/pointer: explain deprecation #70984

dannyc-grafana opened this issue Dec 24, 2024 · 0 comments
Labels
Documentation Tools This label describes issues relating to any tools in the x/tools repository.
Milestone

Comments

@dannyc-grafana
Copy link

What is the URL of the page with the issue?

golang.org/x/tools/go/pointer

What is your user agent?

Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:133.0) Gecko/20100101 Firefox/133.0

Screenshot

No response

What did you do?

I browsed to the page in quesiton

What did you see happen?

Docs are returned, including a version string that clearly indicates the package is deprecated. However, the body of the documentation contains no reference to the reason for deprecation or warning about the same.

What did you expect to see?

I think a warning at the top of the package docs stating that:

  1. The package is deprecated and unmaintained.
  2. There are known correctness bugs
  3. More can be read at x/tools/go/pointer: isolate, tag, and delete the pointer analysis #59676

would be quite useful-- I eventually landed on the issue after digging around, but it took considerably more effort than I'd like to admit.

@seankhliao seankhliao changed the title Update docs on golang.org/x/tools/go/pointer to explain deprecation x/tools/go/pointer: explain deprecation Dec 24, 2024
@gopherbot gopherbot added the Tools This label describes issues relating to any tools in the x/tools repository. label Dec 24, 2024
@gopherbot gopherbot added this to the Unreleased milestone Dec 24, 2024
@Jorropo Jorropo removed the pkgsite label Dec 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Tools This label describes issues relating to any tools in the x/tools repository.
Projects
None yet
Development

No branches or pull requests

3 participants