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

chore: Fix comments that start from an incorrect name #2481

Merged
merged 1 commit into from Oct 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions pkg/chezmoi/actualstateentry.go
Expand Up @@ -102,7 +102,7 @@ func (s *ActualStateAbsent) Remove(system System) error {
return nil
}

// Origin returns s's origin.
// OriginString returns s's origin.
func (s *ActualStateAbsent) OriginString() string {
return s.absPath.String()
}
Expand All @@ -125,7 +125,7 @@ func (s *ActualStateDir) Remove(system System) error {
return system.RemoveAll(s.absPath)
}

// Origin returns s's origin.
// OriginString returns s's origin.
func (s *ActualStateDir) OriginString() string {
return s.absPath.String()
}
Expand Down Expand Up @@ -163,7 +163,7 @@ func (s *ActualStateFile) Remove(system System) error {
return system.RemoveAll(s.absPath)
}

// Origin returns s's origin.
// OriginString returns s's origin.
func (s *ActualStateFile) OriginString() string {
return s.absPath.String()
}
Expand Down Expand Up @@ -195,7 +195,7 @@ func (s *ActualStateSymlink) Remove(system System) error {
return system.RemoveAll(s.absPath)
}

// Origin returns s's origin.
// OriginString returns s's origin.
func (s *ActualStateSymlink) OriginString() string {
return s.absPath.String()
}
2 changes: 1 addition & 1 deletion pkg/chezmoi/entrytypefilter.go
Expand Up @@ -19,7 +19,7 @@ func NewEntryTypeFilter(includeEntryTypeBits, excludeEntryTypeBits EntryTypeBits
}
}

// IncludeEntryTypes returns if entryTypeBits is included.
// IncludeEntryTypeBits returns if entryTypeBits is included.
func (f *EntryTypeFilter) IncludeEntryTypeBits(entryTypeBits EntryTypeBits) bool {
return f.Include.ContainsEntryTypeBits(entryTypeBits) && !f.Exclude.ContainsEntryTypeBits(entryTypeBits)
}
Expand Down
2 changes: 1 addition & 1 deletion pkg/chezmoi/format.go
Expand Up @@ -40,7 +40,7 @@ var (
"yaml": FormatYAML,
}

// Formats is a map of all Formats by extension.
// FormatsByExtension is a map of all Formats by extension.
FormatsByExtension = map[string]Format{
"json": FormatJSON,
"toml": FormatTOML,
Expand Down
2 changes: 1 addition & 1 deletion pkg/chezmoi/gitdiffsystem.go
Expand Up @@ -28,7 +28,7 @@ type GitDiffSystem struct {
unifiedEncoder *diff.UnifiedEncoder
}

// GetDiffSystemOptions are options for NewGitDiffSystem.
// GitDiffSystemOptions are options for NewGitDiffSystem.
type GitDiffSystemOptions struct {
Color bool
Filter *EntryTypeFilter
Expand Down
4 changes: 2 additions & 2 deletions pkg/chezmoi/sourcestateentry.go
Expand Up @@ -231,7 +231,7 @@ func (s SourceStateOriginAbsPath) Path() AbsPath {
return AbsPath(s)
}

// Origin returns s's origin.
// OriginString returns s's origin.
func (s SourceStateOriginAbsPath) OriginString() string {
return AbsPath(s).String()
}
Expand All @@ -241,7 +241,7 @@ func (s SourceStateOriginRemove) Path() AbsPath {
return EmptyAbsPath
}

// Origin returns s's origin.
// OriginString returns s's origin.
func (s SourceStateOriginRemove) OriginString() string {
return "remove"
}