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: support markdown-style links #44645

Open
tbpg opened this issue Feb 26, 2021 · 1 comment
Open

x/pkgsite: support markdown-style links #44645

tbpg opened this issue Feb 26, 2021 · 1 comment

Comments

@tbpg
Copy link
Contributor

@tbpg tbpg commented Feb 26, 2021

What is the URL of the page with the issue?

All of them.

What is your user agent?

N/A.

What did you do?

Have a markdown-style link in my GoDoc. For example:

Check out the awesome [documentation](https://pkg.go.dev).

What did you expect to see?

Check out the awesome documentation.

What did you see instead?

Check out the awesome [documentation](https://pkg.go.dev).

cc @julieqiu

@gopherbot gopherbot added the pkgsite label Feb 26, 2021
@gopherbot gopherbot added this to the Unreleased milestone Feb 26, 2021
@jamalc jamalc modified the milestones: Unreleased, pkgsite/unplanned Feb 26, 2021
@fzipp
Copy link
Contributor

@fzipp fzipp commented Feb 26, 2021

AFAIK doc comments for Go code are intentionally kept markup-free.

"[...] nor must they have their own machine-readable syntax (as with Javadoc). Godoc comments are just good comments, the sort you would want to read even if godoc didn't exist." https://blog.golang.org/godoc

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