summaryrefslogtreecommitdiffstats
path: root/hugofs
diff options
context:
space:
mode:
authorOleksandr Redko <Oleksandr_Redko@epam.com>2023-05-18 12:05:56 +0300
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2023-05-18 21:25:27 +0200
commit610cedaa61cf1f318ecd4a7818a896b1e56e7662 (patch)
tree3c206f0386b05b44ec1f3bd00f9d96f6904c8446 /hugofs
parent24e7d0c174a24a016f65be46765ab9c795e1e123 (diff)
all: Fix comments for exported functions and packages
Diffstat (limited to 'hugofs')
-rw-r--r--hugofs/fs.go6
1 files changed, 3 insertions, 3 deletions
diff --git a/hugofs/fs.go b/hugofs/fs.go
index 855a821df..5dae3a78a 100644
--- a/hugofs/fs.go
+++ b/hugofs/fs.go
@@ -85,7 +85,7 @@ func NewFromOld(fs afero.Fs, cfg config.Provider) *Fs {
return newFs(fs, fs, workingDir, publishDir)
}
-// NewFrom creates a new Fs based on the provided Afero Fss
+// NewFromSourceAndDestination creates a new Fs based on the provided Afero Fss
// as the source and destination file systems.
func NewFromSourceAndDestination(source, destination afero.Fs, cfg config.Provider) *Fs {
workingDir, publishDir := getWorkingPublishDir(cfg)
@@ -178,7 +178,7 @@ func MakeReadableAndRemoveAllModulePkgDir(fs afero.Fs, dir string) (int, error)
return counter, fs.RemoveAll(dir)
}
-// HasOsFs returns whether fs is an OsFs or if it fs wraps an OsFs.
+// IsOsFs returns whether fs is an OsFs or if it fs wraps an OsFs.
// TODO(bep) make this nore robust.
func IsOsFs(fs afero.Fs) bool {
var isOsFs bool
@@ -202,7 +202,7 @@ type FilesystemsUnwrapper interface {
UnwrapFilesystems() []afero.Fs
}
-// FilesystemsProvider returns the underlying filesystem.
+// FilesystemUnwrapper returns the underlying filesystem.
type FilesystemUnwrapper interface {
UnwrapFilesystem() afero.Fs
}