documentation and API improvements

3 files changed, 25 insertions, 24 deletions

diff --git a/config/config.go b/config/config.go
index 65b51eb..259ebf9 100644
--- a/config/config.go
+++ b/config/config.go
@@ -32,17 +32,18 @@ var (
 // Config contains the repository configuration
 // ftp://www.kernel.org/pub/software/scm/git/docs/git-config.html#FILES
 type Config struct {
-	// Core variables
 	Core struct {
 		// IsBare if true this repository is assumed to be bare and has no
-		// working directory associated with it
+		// working directory associated with it.
 		IsBare bool
-		// Worktree is the path to the root of the working tree
+		// Worktree is the path to the root of the working tree.
 		Worktree string
 	}
-	// Remotes list of repository remotes
+	// Remotes list of repository remotes, the key of the map is the name
+	// of the remote, should equal to RemoteConfig.Name.
 	Remotes map[string]*RemoteConfig
-	// Submodules list of repository submodules
+	// Submodules list of repository submodules, the key of the map is the name
+	// of the submodule, should equal to Submodule.Name.
 	Submodules map[string]*Submodule
 
 	// contains the raw information of a config file, the main goal is preserve
@@ -51,7 +52,7 @@ type Config struct {
 	raw *format.Config
 }
 
-// NewConfig returns a new empty Config
+// NewConfig returns a new empty Config.
 func NewConfig() *Config {
 	return &Config{
 		Remotes:    make(map[string]*RemoteConfig, 0),
@@ -60,7 +61,7 @@ func NewConfig() *Config {
 	}
 }
 
-// Validate validates the fields and sets the default values
+// Validate validates the fields and sets the default values.
 func (c *Config) Validate() error {
 	for name, r := range c.Remotes {
 		if r.Name != name {
@@ -85,7 +86,7 @@ const (
 	worktreeKey      = "worktree"
 )
 
-// Unmarshal parses a git-config file and stores it
+// Unmarshal parses a git-config file and stores it.
 func (c *Config) Unmarshal(b []byte) error {
 	r := bytes.NewBuffer(b)
 	d := format.NewDecoder(r)
@@ -133,7 +134,7 @@ func (c *Config) unmarshalSubmodules() {
 	}
 }
 
-// Marshal returns Config encoded as a git-config file
+// Marshal returns Config encoded as a git-config file.
 func (c *Config) Marshal() ([]byte, error) {
 	c.marshalCore()
 	c.marshalRemotes()
@@ -182,7 +183,7 @@ func (c *Config) marshalSubmodules() {
 	}
 }
 
-// RemoteConfig contains the configuration for a given remote repository
+// RemoteConfig contains the configuration for a given remote repository.
 type RemoteConfig struct {
 	// Name of the remote
 	Name string
@@ -196,7 +197,7 @@ type RemoteConfig struct {
 	raw *format.Subsection
 }
 
-// Validate validates the fields and sets the default values
+// Validate validates the fields and sets the default values.
 func (c *RemoteConfig) Validate() error {
 	if c.Name == "" {
 		return ErrRemoteConfigEmptyName
diff --git a/config/modules.go b/config/modules.go
index a17cc27..3d01117 100644
--- a/config/modules.go
+++ b/config/modules.go
@@ -15,7 +15,7 @@ var (
 // Modules defines the submodules properties, represents a .gitmodules file
 // https://www.kernel.org/pub/software/scm/git/docs/gitmodules.html
 type Modules struct {
-	// Submodules is a map of submodules being the key the name of the submodule
+	// Submodules is a map of submodules being the key the name of the submodule.
 	Submodules map[string]*Submodule
 
 	raw *format.Config
@@ -34,7 +34,7 @@ const (
 	branchKey = "branch"
 )
 
-// Unmarshal parses a git-config file and stores it
+// Unmarshal parses a git-config file and stores it.
 func (m *Modules) Unmarshal(b []byte) error {
 	r := bytes.NewBuffer(b)
 	d := format.NewDecoder(r)
@@ -55,7 +55,7 @@ func (m *Modules) Unmarshal(b []byte) error {
 	return nil
 }
 
-// Marshal returns Modules encoded as a git-config file
+// Marshal returns Modules encoded as a git-config file.
 func (m *Modules) Marshal() ([]byte, error) {
 	s := m.raw.Section(submoduleSection)
 	s.Subsections = make(format.Subsections, len(m.Submodules))
@@ -74,12 +74,12 @@ func (m *Modules) Marshal() ([]byte, error) {
 	return buf.Bytes(), nil
 }
 
-// Submodule defines a submodule
+// Submodule defines a submodule.
 type Submodule struct {
 	// Name module name
 	Name string
 	// Path defines the path, relative to the top-level directory of the Git
-	// working tree,
+	// working tree.
 	Path string
 	// URL defines a URL from which the submodule repository can be cloned.
 	URL string
@@ -88,11 +88,11 @@ type Submodule struct {
 	Branch string
 
 	// raw representation of the subsection, filled by marshal or unmarshal are
-	// called
+	// called.
 	raw *format.Subsection
 }
 
-// Validate validates the fields and sets the default values
+// Validate validates the fields and sets the default values.
 func (m *Submodule) Validate() error {
 	if m.Path == "" {
 		return ErrModuleEmptyPath
diff --git a/config/refspec.go b/config/refspec.go
index dd68edc..9441df8 100644
--- a/config/refspec.go
+++ b/config/refspec.go
@@ -49,7 +49,7 @@ func (s RefSpec) Validate() error {
 	return ErrRefSpecMalformedWildcard
 }
 
-// IsForceUpdate returns if update is allowed in non fast-forward merges
+// IsForceUpdate returns if update is allowed in non fast-forward merges.
 func (s RefSpec) IsForceUpdate() bool {
 	if s[0] == refSpecForce[0] {
 		return true
@@ -67,7 +67,7 @@ func (s RefSpec) IsDelete() bool {
 	return false
 }
 
-// Src return the src side
+// Src return the src side.
 func (s RefSpec) Src() string {
 	spec := string(s)
 	start := strings.Index(spec, refSpecForce) + 1
@@ -76,7 +76,7 @@ func (s RefSpec) Src() string {
 	return spec[start:end]
 }
 
-// Match match the given plumbing.ReferenceName against the source
+// Match match the given plumbing.ReferenceName against the source.
 func (s RefSpec) Match(n plumbing.ReferenceName) bool {
 	if !s.IsWildcard() {
 		return s.matchExact(n)
@@ -85,7 +85,7 @@ func (s RefSpec) Match(n plumbing.ReferenceName) bool {
 	return s.matchGlob(n)
 }
 
-// IsWildcard returns true if the RefSpec contains a wildcard
+// IsWildcard returns true if the RefSpec contains a wildcard.
 func (s RefSpec) IsWildcard() bool {
 	return strings.Index(string(s), refSpecWildcard) != -1
 }
@@ -110,7 +110,7 @@ func (s RefSpec) matchGlob(n plumbing.ReferenceName) bool {
 		strings.HasSuffix(name, suffix)
 }
 
-// Dst returns the destination for the given remote reference
+// Dst returns the destination for the given remote reference.
 func (s RefSpec) Dst(n plumbing.ReferenceName) plumbing.ReferenceName {
 	spec := string(s)
 	start := strings.Index(spec, refSpecSeparator) + 1
@@ -133,7 +133,7 @@ func (s RefSpec) String() string {
 	return string(s)
 }
 
-// MatchAny returns true if any of the RefSpec match with the given ReferenceName
+// MatchAny returns true if any of the RefSpec match with the given ReferenceName.
 func MatchAny(l []RefSpec, n plumbing.ReferenceName) bool {
 	for _, r := range l {
 		if r.Match(n) {