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

encoding/base64: documentation issues #13011

Closed
dolmen opened this issue Oct 21, 2015 · 2 comments
Closed

encoding/base64: documentation issues #13011

dolmen opened this issue Oct 21, 2015 · 2 comments
Labels
Documentation FrozenDueToAge
Milestone
Go1.6

Comments

@dolmen
Copy link
Contributor

dolmen commented Oct 21, 2015

The documentation for the encoding/base64 package is difficult to follow because some bits are not documented or in a wrong order:

  • constants encodeStd and encodeURL are not documented. But they are referenced in the documentation for variables StdEncoding and URLEncoding...
  • RawStdEncoding and RawURLEncoding variables are documented before StdEncoding and URLEncoding while the former are defined using the later.
  • functions NewEncoder and NewDecoder are documented before the Encoding type and its methods.
@ianlancetaylor ianlancetaylor added this to the Go1.6 milestone Oct 21, 2015
@adg
Copy link
Contributor

adg commented Oct 22, 2015

These are all a result of how godoc works in general. See the godoc blog post for details.

Probably a package-level example would help.

@gopherbot
Copy link
Contributor

CL https://golang.org/cl/17231 mentions this issue.

@rsc rsc closed this as completed in e4e4942 Dec 1, 2015
@golang golang locked and limited conversation to collaborators Dec 1, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation FrozenDueToAge
Projects
None yet
Milestone
Go1.6
Development

No branches or pull requests
4 participants
@dolmen @ianlancetaylor @adg @gopherbot