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: documentation for xml start & end elements is redundant #29566

Closed
isomorphisms opened this issue Jan 4, 2019 · 2 comments
Closed

encoding/xml: documentation for xml start & end elements is redundant #29566

isomorphisms opened this issue Jan 4, 2019 · 2 comments
Labels

Comments

@isomorphisms
Copy link

@isomorphisms isomorphisms commented Jan 4, 2019

The documentation for encodings/xml/xml.go is repetitive and not helpful. "End returns an EndElement". "EndElement is an EndElement". So, what is an XML end element?

@katiehockman katiehockman changed the title xml start & end elements encoding/xml: documentation for xml start & end elements is redundant Jan 4, 2019
@katiehockman

This comment has been minimized.

Copy link
Member

@katiehockman katiehockman commented Jan 4, 2019

@isomorphisms The godoc for EndElement is "An EndElement represents an XML end element." XML elements are not specific to Go or the encoding/xml package.

For questions about Go, see https://golang.org/wiki/Questions.

I am going to close this issue for now, but please re-open if you don't feel like your issue has been addressed.

@isomorphisms

This comment has been minimized.

Copy link
Author

@isomorphisms isomorphisms commented Mar 22, 2019

@katiehockman Thanks Katie. I didn’t have time (nor authority) to change the godoc comment for the function. I think it should be improved. The existing docstring violates official recommended go practice (as stated in, iirc, the Effective Go blog).

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
2 participants
You can’t perform that action at this time.