diff options
| author | Jorin Vogel <[email protected]> | 2017-08-02 14:25:05 +0200 |
|---|---|---|
| committer | Bjørn Erik Pedersen <[email protected]> | 2017-08-03 15:57:51 +0200 |
| commit | 81c13171a985b89f2af6682dbd1d4b8766cb9af7 (patch) | |
| tree | db39d78bbe6da0ea3f3dd3d2f94c7e1571ad8fd6 /hugofs/fs.go | |
| parent | 9891c0fb0eb274b8a95b62c40070a87a6e04088c (diff) | |
| download | hugo-81c13171a985b89f2af6682dbd1d4b8766cb9af7.tar.gz hugo-81c13171a985b89f2af6682dbd1d4b8766cb9af7.zip | |
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 'hugofs/fs.go')
| -rw-r--r-- | hugofs/fs.go | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/hugofs/fs.go b/hugofs/fs.go index 27465b459..52e27bd12 100644 --- a/hugofs/fs.go +++ b/hugofs/fs.go @@ -22,6 +22,8 @@ import ( // Os points to an Os Afero file system. var Os = &afero.OsFs{} +// Fs abstracts the file system to separate source and destination file systems +// and allows both to be mocked for testing. type Fs struct { // Source is Hugo's source file system. Source afero.Fs @@ -30,6 +32,7 @@ type Fs struct { Destination afero.Fs // Os is an OS file system. + // NOTE: Field is currently unused. Os afero.Fs // WorkingDir is a read-only file system |