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

encoding/xml: bulleted lists badly formatted in documentation #26778

Closed
bcmills opened this issue Aug 2, 2018 · 7 comments
Closed

encoding/xml: bulleted lists badly formatted in documentation #26778

bcmills opened this issue Aug 2, 2018 · 7 comments

Comments

@bcmills
Copy link
Member

@bcmills bcmills commented Aug 2, 2018

The bulleted lists in the doc comments for Marshal, Unmarshal, and perhaps others are indented in a way that confuses the formatter for golang.org/pkg. (It thinks they're code instead of prose.)

screenshot 2018-08-02 at 16 42 16

@cespare

This comment has been minimized.

Copy link
Contributor

@cespare cespare commented Aug 2, 2018

Isn't this the intentional, hacky workaround for #7873?

@bradfitz

This comment has been minimized.

Copy link
Contributor

@bradfitz bradfitz commented Aug 2, 2018

"Working as Compromised"

@bcmills

This comment has been minimized.

Copy link
Member Author

@bcmills bcmills commented Aug 2, 2018

Maybe, but to paraphrase a fashion tip: write for the formatter you have, not the formatter you want.

@bradfitz

This comment has been minimized.

Copy link
Contributor

@bradfitz bradfitz commented Aug 2, 2018

Um, that's exactly what we did. Did you get the quote backwards?

@cespare

This comment has been minimized.

Copy link
Contributor

@cespare cespare commented Aug 2, 2018

@bcmills btw you may find my examples listed at #7873 (comment) to be interesting. In at least one place (net/http) we used a different workaround (unicode bullets). Maybe you will be motivated to add your voice to #7873 :)

@bcmills

This comment has been minimized.

Copy link
Member Author

@bcmills bcmills commented Aug 2, 2018

Um, that's exactly what we did.

I mean: if we can't render bulleted lists, don't use them at all. (Paragraphs‽)

@cespare

This comment has been minimized.

Copy link
Contributor

@cespare cespare commented Aug 2, 2018

@bcmills well, we have a lot of instances of this type of list in the stdlib; maybe this bug should be closed? Unless you want to try to make the change across the whole codebase (unlikely to be popular, I imagine).

@bcmills bcmills closed this Aug 2, 2018
@golang golang locked and limited conversation to collaborators Aug 2, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.