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

Go documentation is missing reference links #2157

Open
izidormatusov opened this issue Feb 19, 2024 · 0 comments
Open

Go documentation is missing reference links #2157

izidormatusov opened this issue Feb 19, 2024 · 0 comments

Comments

@izidormatusov
Copy link

Documentation style bug: Go documentation missing reference links

Summary

devdocs.io is missing useful links in Go reference documentation that are very handy when working with package API:

  • links to the Go source code implementation for the code
  • links to input/output structures

I'm happy to contribute a fix if this is a bug rather than a deliberate choice.

Actual style

See https://devdocs.io/go/net/http/index#Client.Do and how the header does not have links:

Screenshot 2024-02-18 at 21 03 19

Expected style

Official documentation that has links in the header: https://pkg.go.dev/net/http#Client.Do
Screenshot 2024-02-18 at 21 03 28

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant