package plumbing documentation improvements #248
Conversation
Codecov Report@@ Coverage Diff @@
## master #248 +/- ##
=======================================
Coverage 76.91% 76.91%
=======================================
Files 108 108
Lines 7347 7347
=======================================
Hits 5651 5651
Misses 1106 1106
Partials 590 590
Continue to review full report at Codecov.
|
plumbing/format/config/common.go
Outdated
| type Includes []*Include | ||
|
|
||
| // A reference to an included configuration. | ||
| // Include is reference to an included config file |
There was a problem hiding this comment.
End the comment with a full stop.
plumbing/format/config/common.go
Outdated
| type Include struct { | ||
| Path string | ||
| Config *Config | ||
| } | ||
|
|
||
| // Comment string with out the prefix '#' or ';' |
There was a problem hiding this comment.
End the comment with a full stop.
plumbing/format/config/common.go
Outdated
| type Comment string | ||
|
|
||
| const ( | ||
| // NoSubsection token used to avoid provide a section to the Config.Section |
There was a problem hiding this comment.
Alternative wording: NoSubsection token is passed to Config.Section and Config.SetSection to represent the absence of a section.
There was a problem hiding this comment.
End the comment with a full stop.
plumbing/format/config/common.go
Outdated
| @@ -5,26 +5,32 @@ func New() *Config { | |||
| return &Config{} | |||
| } | |||
|
|
|||
| // Config contains all the sections, comments and includes from a config file | |||
There was a problem hiding this comment.
End the comment with a full stop.
plumbing/format/config/common.go
Outdated
| type Config struct { | ||
| Comment *Comment | ||
| Sections Sections | ||
| Includes Includes | ||
| } | ||
|
|
||
| // Includes is a list of Includes in a config file |
There was a problem hiding this comment.
End the comment with a full stop.
plumbing/transport/client/client.go
Outdated
| @@ -1,3 +1,5 @@ | |||
| // Package client contains helper function to deal with the different client | |||
| // protocols | |||
There was a problem hiding this comment.
End sentence with a full stop.
plumbing/transport/file/client.go
Outdated
| @@ -1,3 +1,4 @@ | |||
| // Package file implements the file transport protocol | |||
There was a problem hiding this comment.
End sentence with a full stop.
plumbing/transport/git/common.go
Outdated
| @@ -1,3 +1,4 @@ | |||
| // Package git implements the git transport protocol | |||
There was a problem hiding this comment.
End sentence with a full stop.
plumbing/transport/http/common.go
Outdated
| @@ -1,4 +1,4 @@ | |||
| // Package http implements a HTTP client for go-git. | |||
| // Package http implements the HTTP transport protocol | |||
There was a problem hiding this comment.
End sentence with a full stop.
plumbing/transport/ssh/common.go
Outdated
| @@ -1,3 +1,4 @@ | |||
| // Package file implements the SSH transport protocol | |||
There was a problem hiding this comment.
End sentence with a full stop.
plumbing/format/config/common.go
Outdated
| @@ -5,32 +5,32 @@ func New() *Config { | |||
| return &Config{} | |||
| } | |||
|
|
|||
| // Config contains all the sections, comments and includes from a config file | |||
| // Config contains all the sections, comments and includes from a config file, | |||
plumbing/format/config/common.go
Outdated
| @@ -81,7 +81,7 @@ func (c *Config) RemoveSection(name string) *Config { | |||
| return c | |||
| } | |||
|
|
|||
| // RemoveSubsection remove a subsection from a config file | |||
| // RemoveSubsection remove a subsection from a config file. | |||
plumbing/format/index/index.go
Outdated
| @@ -94,7 +94,7 @@ type TreeEntry struct { | |||
| } | |||
|
|
|||
| // ResolveUndo is used when a conflict is resolved (e.g. with "git add path"), | |||
| // these higher stage entries will be removed and a stage-0 entry with proper | |||
| // these higher stage entries are removed and a stage-0 entry with proper | |||
There was a problem hiding this comment.
End the paragraph with a full stop.
I still don't understand anything in this paragraph, can you re-write this paragraph with your own words: explaining what are you planning to do with it in simple words, what is a stage, what is a stage-0 entry, what undo extension is it referring to, etc.
plumbing/revlist/revlist.go
Outdated
| @@ -1,5 +1,5 @@ | |||
| // Package revlist implementation to walk the objects referenced by a commit | |||
| // history. Roughly equivalent to git-rev-list command. | |||
| // Package revlist is a implementation to walk the objects referenced by a | |||
There was a problem hiding this comment.
s/ a / an /
The sentence still doesn't make sense, revlist is a package, not an implementation (an implementation of what?).
Consider this other sentence instead: Package revlist provides support to access the ancestors of commits, in a similar way as the git-rev-list command.
ajnavarro
changed the title
#242