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

Possible Godoc improvements #27

Closed
acln0 opened this issue Jul 17, 2018 · 0 comments
Closed

Possible Godoc improvements #27

acln0 opened this issue Jul 17, 2018 · 0 comments
Assignees
Milestone

Comments

@acln0
Copy link
Member

acln0 commented Jul 17, 2018

I think https://godoc.org/github.com/gofrs/uuid#Equal should say "Nil is the nil UUID...".

https://godoc.org/github.com/gofrs/uuid#UUID.UnmarshalText should mention the braced hashlike format, as described in #14, and the URN hashlike format as in

uuid/codec_test.go

Lines 131 to 134 in 57be146

{
input: "urn:uuid:6ba7b8109dad11d180b400c04fd430c8",
variant: "URNHashlike",
},
.

Perhaps https://godoc.org/github.com/gofrs/uuid#DefaultGenerator could be placed outside the var block it is currently in, standing alone instead, to reduce noise and to promote the comment to a "proper Godoc" rather than code comment.

Perhaps the comment on https://godoc.org/github.com/gofrs/uuid#UUID could also be improved. It feels like it needs a verb.

@acln0 acln0 added this to the 2.0.0 milestone Jul 17, 2018
@theckman theckman self-assigned this Jul 18, 2018
theckman added a commit that referenced this issue Jul 18, 2018
This updates the package comments in different areas to improve the GoDoc
rendering of the documentation.

Fixes #27

Signed-off-by: Tim Heckman <t@heckman.io>
theckman added a commit that referenced this issue Jul 18, 2018
This updates the package comments in different areas to improve the GoDoc
rendering of the documentation.

Fixes #27

Signed-off-by: Tim Heckman <t@heckman.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants