Update package comments to provide better documentation #29
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
acln0
requested changes
Jul 18, 2018
| // | ||
| // braced := '{' plain '}' | '{' hashlike '}' | ||
| // urn := URN ':' UUID-NID ':' plain | ||
| // |
There was a problem hiding this comment.
I think this newline can be removed.
There was a problem hiding this comment.
@acln0 I intentionally kept it because it otherwise looked too bunched-up next to the function header, when viewing the source code. This is a pretty large comment, so it helped.
There was a problem hiding this comment.
Aha, I see. Well, if it looks fine in Godoc, we can keep it. That was the only concern.
There was a problem hiding this comment.
To loop back around, looks to be okay!
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>
acln0
approved these changes
Jul 18, 2018
theckman
added a commit
that referenced
this pull request
Jul 18, 2018
Update package comments to provide better documentation 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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