cmd/docgen: implement documentation generator #132
Merged
Conversation
This file contains hidden or 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
|
Is |
quasilyte
reviewed
Jun 3, 2018
cmd/makedocs/main.go
Outdated
| package main | ||
|
|
||
| import ( | ||
| "html/template" |
There was a problem hiding this comment.
You should probably use text/template.
This way, there shouldn't be any weird escaping problems in the output.
quasilyte
reviewed
Jun 3, 2018
docs/overview.md
Outdated
|
|
||
| **After** | ||
| ```go | ||
| x := xs[i+1] |
There was a problem hiding this comment.
These escaped sequences are probably there due to html/template usage.
quasilyte
reviewed
Jun 3, 2018
| Checkers []checker | ||
| }{ | ||
| Checkers: checkers, | ||
| }) |
There was a problem hiding this comment.
You can use bytes.Buffer for tmpl.Execute and then do ioutil.WriteFile.
This way, you don't need to mess around OpenFile and it's flags, you don't need to close file either.
quasilyte
reviewed
Jun 3, 2018
cmd/makedocs/main.go
Outdated
| } | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } |
There was a problem hiding this comment.
What error does it check?
Seems like these 3 lines are not needed here.
quasilyte
reviewed
Jun 3, 2018
cmd/makedocs/main.go
Outdated
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| ioutil.WriteFile(docsPath+"overview.md", buf.Bytes(), 0600) |
There was a problem hiding this comment.
- ioutil.WriteFile(docsPath+"overview.md", buf.Bytes(), 0600)
+ if err := ioutil.WriteFile(docsPath+"overview.md", buf.Bytes(), 0600); err != nil {
+ log.Fatalf("write output file: %v", err)
+ }
quasilyte
reviewed
Jun 3, 2018
cmd/makedocs/main.go
Outdated
| if err != nil { | ||
| return "", err | ||
| } | ||
| return string(b), nil |
There was a problem hiding this comment.
- if err != nil {
- return "", err
- }
- return string(b), nil
+ return string(b), err
quasilyte
approved these changes
Jun 3, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
fixes #132