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

Fix code block format in doc #59

Merged
merged 1 commit into from
Jul 18, 2017
Merged

Fix code block format in doc #59

merged 1 commit into from
Jul 18, 2017

Conversation

shihanng
Copy link
Contributor

@shihanng shihanng commented Jul 18, 2017

Hi, thank you for providing this package. While using it, I found that the code blocks in the docs seem a bit odd. One of the formatting rule that Godoc uses is:

Pre-formatted text must be indented relative to the surrounding comment text

This PR provides the simple according to the above. The following is the resulting doc rendered in HTML:

screen shot 2017-07-18 at 9 07 51

@SlyMarbo SlyMarbo merged commit 68215f9 into SlyMarbo:master Jul 18, 2017
@SlyMarbo
Copy link
Owner

Thanks for this. I must've copied the text from the README and forgotten to reformat it.

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

Successfully merging this pull request may close these issues.

2 participants