Fix minor godoc typos in any package #569
Merged
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
An extra space was causing Examples 3 and 4 to render in Example 2's code block. This commit fixes those minor typos. Also removing the `====` denoting the JSON section will allow godoc to render a heading here. Signed-off-by: John McCabe <john@johnmccabe.net>
|
Thanks! |
neild
pushed a commit
to neild/protobuf
that referenced
this pull request
Mar 28, 2018
An extra space was causing Examples 3 and 4 to render in Example 2's code block. This commit fixes those minor typos. Also removing the `====` denoting the JSON section will allow godoc to render a heading here. Signed-off-by: John McCabe <john@johnmccabe.net>
|
Thank you for the doc fix. However, given the issues we're discovering in #569, perhaps we should roll this back? Poorly generated godoc is affecting the godoc for nearly all of the well-known types (not just |
|
I'm okay with either rolling back or leaving it until it gets overwritten when we merge dev to master. Up to you. |
|
Apologies, I meant to reference #570. |
|
Had just seen that, if theres anything you need me to do my side just shout. |
chyroc
pushed a commit
to chyroc/protobuf
that referenced
this pull request
May 1, 2018
An extra space was causing Examples 3 and 4 to render in Example 2's code block. This commit fixes those minor typos. Also removing the `====` denoting the JSON section will allow godoc to render a heading here. Signed-off-by: John McCabe <john@johnmccabe.net>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
An extra space was causing Examples 3 and 4 to render in Example 2's code block. This commit fixes those minor typos.
Also removing the
====denoting the JSON section will allow godoc to render a heading here.Before - click to expand
After - click to expand