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: add source code links for constants #40939

Closed
julieqiu opened this issue Aug 20, 2020 · 5 comments
Closed

x/pkgsite: add source code links for constants #40939

julieqiu opened this issue Aug 20, 2020 · 5 comments

Comments

@julieqiu
Copy link
Contributor

@julieqiu julieqiu commented Aug 20, 2020

At the moment, if you want to know that the constant internal/race.Enabled depends on build tags, you'll need to go to the file that defines the constant to see what its exact build tags are, because the constant does not link to the source code.

image

This requires knowing what file the constant is defined in, and navigating to figure out where the code is. We should consider providing source code links for constants.

@gopherbot
Copy link

@gopherbot gopherbot commented Dec 13, 2020

Change https://golang.org/cl/277633 mentions this issue: content,internal/godoc/dochtml/internal/render: move pre tag to tmpl

@gopherbot
Copy link

@gopherbot gopherbot commented Dec 13, 2020

Change https://golang.org/cl/277632 mentions this issue: content,internal/godoc/dochtml: add declaration.tmpl

gopherbot pushed a commit to golang/pkgsite that referenced this issue Dec 14, 2020
Logic for rendering code snippets from the output of render_decl is
moved to a helper template.

The </br> tag is removed for the Constants and Variables sections:
https://photos.app.goo.gl/FosXd66T3nfufaXf7

For golang/go#40939
For golang/go#42486

Change-Id: Icfe61be5f164e0be54e5357602477fc9ed24b05d
Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/277632
Reviewed-by: Jonathan Amsterdam <jba@google.com>
Trust: Julie Qiu <julie@golang.org>
gopherbot pushed a commit to golang/pkgsite that referenced this issue Dec 14, 2020
The $out.decl <pre> tag is now generated in the declaration.tmpl,
instead of as a string concatentation in formatDeclHTML.

This will make it easier to style this element in a future CL.

For golang/go#40939
For golang/go#42486

Change-Id: I2f5c0a339020deac002ed32a12ccf68f691cba8f
Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/277633
Trust: Julie Qiu <julie@golang.org>
Run-TryBot: Julie Qiu <julie@golang.org>
TryBot-Result: kokoro <noreply+kokoro@google.com>
Reviewed-by: Jamal Carvalho <jamal@golang.org>
@gopherbot
Copy link

@gopherbot gopherbot commented Dec 15, 2020

Change https://golang.org/cl/278434 mentions this issue: content/static: display source code link HTML

@julieqiu
Copy link
Contributor Author

@julieqiu julieqiu commented Dec 15, 2020

See #42486 (comment) for a mock.

gopherbot pushed a commit to golang/pkgsite that referenced this issue Dec 15, 2020
The HTML for the source code link is added. The style is set to
display:none, and will be styled in a future CL.

There are no user facing changes in this CL.

For golang/go#40939
For golang/go#42486

Change-Id: I01ba3ead6b2d0a9ea7dc1488d3b9f5eadb33d472
Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/278434
Reviewed-by: Jamal Carvalho <jamal@golang.org>
Trust: Julie Qiu <julie@golang.org>
@gopherbot
Copy link

@gopherbot gopherbot commented Jan 6, 2021

Change https://golang.org/cl/282072 mentions this issue: content/static: styles for view source link in code snippets

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
2 participants