diff options
| author | Jorin Vogel <hi@jorin.me> | 2017-08-02 14:25:05 +0200 |
|---|---|---|
| committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2017-08-03 15:57:51 +0200 |
| commit | 81c13171a985b89f2af6682dbd1d4b8766cb9af7 (patch) | |
| tree | db39d78bbe6da0ea3f3dd3d2f94c7e1571ad8fd6 /helpers/path.go | |
| parent | 9891c0fb0eb274b8a95b62c40070a87a6e04088c (diff) | |
Add some missing doc comments
As pointed out by the linter, some exported functions and types are
missing doc comments.
The linter warnings have been reduced from 194 to 116.
Not all missing comments have been added in this commit though.
Diffstat (limited to 'helpers/path.go')
| -rw-r--r-- | helpers/path.go | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/helpers/path.go b/helpers/path.go index 640c97aa2..fccba2238 100644 --- a/helpers/path.go +++ b/helpers/path.go @@ -32,6 +32,7 @@ var ( // ErrThemeUndefined is returned when a theme has not be defined by the user. ErrThemeUndefined = errors.New("no theme set") + // ErrWalkRootTooShort is returned when the root specified for a file walk is shorter than 4 characters. ErrWalkRootTooShort = errors.New("Path too short. Stop walking.") ) @@ -480,7 +481,7 @@ func FindCWD() (string, error) { // SymbolicWalk is like filepath.Walk, but it supports the root being a // symbolic link. It will still not follow symbolic links deeper down in -// the file structure +// the file structure. func SymbolicWalk(fs afero.Fs, root string, walker filepath.WalkFunc) error { // Sanity check |