Several small documentation fixes #382
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
Closed
dmitshur
reviewed
Jul 29, 2017
html.go
Outdated
| // block nodes it will be called twice: first time with entering=true, second | ||
| // time with entering=false, so that it could know when it's working on an open | ||
| // block nodes it will be called twice: first time with entering=True, second | ||
| // time with entering=False, so that it could know when it's working on an open |
There was a problem hiding this comment.
Why this change? Isn't lower case correct? https://godoc.org/builtin#true
There was a problem hiding this comment.
Wow, that's a brain fart. Obviously too much Python lately :-). I'll fix it, thanks!
dmitshur
reviewed
Jul 29, 2017
README.md
Outdated
| output := blackfriday.Run(input) | ||
| ``` |
There was a problem hiding this comment.
When you go from indented code block to fenced code block, you should get rid of the indentation, since it'll now be a part of the code block. This should become:
```go
output := blackfriday.Run(input)
```
Also, it's more common not to include a space after the three backticks (as far as I know).
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.
I went through README and the docs and picked out some remaining inaccuracies.