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

cmd/go: documentation at golang.org for cmd/go has confusing formatting #44846

Closed
kortschak opened this issue Mar 7, 2021 · 3 comments
Closed
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Milestone

Comments

@kortschak
Copy link
Contributor

What version of Go are you using (go version)?

$ go version
go version go1.16

Does this issue reproduce with the latest release?

Yes

What did you do?

Visit this documentation.

What did you expect to see?

Properly formatted bullet points if they must be used.

What did you see instead?

Bullet points that have <pre> text due to >1 space indent.

Screenshot from 2021-03-08 07-10-07

The current system for documentation rendering is not capable of rendering multi-line bullet points with consistent indentation, so probably that formatting approach shouldn't be used.

@jayconrod jayconrod added the NeedsFix The path to resolution is known, but the work has not been done. label Mar 8, 2021
@jayconrod jayconrod added this to the Go1.17 milestone Mar 8, 2021
@jayconrod
Copy link
Contributor

@gopherbot Please backport to 1.16. This is a fix for documentation that will be current for several more months.

@gopherbot
Copy link

Backport issue(s) opened: #44860 (for 1.16).

Remember to create the cherry-pick CL(s) as soon as the patch is submitted to master, according to https://golang.org/wiki/MinorReleases.

@gopherbot
Copy link

Change https://golang.org/cl/301329 mentions this issue: cmd/go: fix godoc formatting for text from 'go help install'

@golang golang locked and limited conversation to collaborators Mar 12, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Development

No branches or pull requests

3 participants