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

Jump to bottom

x/pkgsite: support markdown-style links #44645

Closed
tbpg opened this issue Feb 26, 2021 · 2 comments
Closed

x/pkgsite: support markdown-style links #44645

tbpg opened this issue Feb 26, 2021 · 2 comments
Labels
FrozenDueToAge NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. pkgsite
Milestone
pkgsite/unplanned

Comments

@tbpg
Copy link
Contributor

tbpg commented Feb 26, 2021 •
edited

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 this to the Unreleased milestone Feb 26, 2021
@jamalc jamalc added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Feb 26, 2021
@jamalc jamalc modified the milestones: Unreleased, pkgsite/unplanned Feb 26, 2021
@fzipp
Copy link
Contributor

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

@tbpg
Copy link
Contributor Author

tbpg commented Sep 10, 2021

Closing in favor of the discussion in #48305.

@tbpg tbpg closed this as completed Sep 10, 2021
@golang golang locked and limited conversation to collaborators Sep 10, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. pkgsite
Projects
None yet
Milestone
pkgsite/unplanned
Development

No branches or pull requests
4 participants
@fzipp @gopherbot @jamalc @tbpg