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.

Sign up for GitHub

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/tools/present: legacy present syntax in package doc #58999

Closed
crisman opened this issue Mar 13, 2023 · 1 comment
Closed

x/tools/present: legacy present syntax in package doc #58999

crisman opened this issue Mar 13, 2023 · 1 comment
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. Tools This label describes issues relating to any tools in the x/tools repository.
Milestone
Unreleased

Comments

@crisman
Copy link
Contributor

crisman commented Mar 13, 2023

What did you do?

View the present docs here:

https://pkg.go.dev/golang.org/x/tools/present#hdr-Legacy_Present_Syntax

The last line of that section is about the link format used for the legacy present syntax.

What did you expect to see?

Links can be included in any text with the form [[url][label]], or [[url]] to use the URL itself as the label.

What did you see instead?

Links can be included in any text with the form [url[label]], or [url] to use the URL itself as the label.

Notice the unescaped "legacy present syntax" for links in the markdown doc which is being parsed as a markdown url with some extra square brackets around.
@gopherbot gopherbot added the Tools This label describes issues relating to any tools in the x/tools repository. label Mar 13, 2023
@gopherbot gopherbot added this to the Unreleased milestone Mar 13, 2023
@seankhliao seankhliao changed the title x/tools/present: legacy present syntax in doc md x/tools/present: legacy present syntax in package doc Mar 13, 2023
@seankhliao seankhliao added Documentation Issues describing a change to documentation. NeedsFix The path to resolution is known, but the work has not been done. labels Mar 13, 2023
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/475975 mentions this issue: present: reformat doc comment for lack of inline code

@golang golang locked and limited conversation to collaborators May 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
None yet
Milestone
Unreleased
Development

No branches or pull requests
3 participants
@crisman @gopherbot @seankhliao