summaryrefslogtreecommitdiffhomepage
path: root/tpl/os
diff options
context:
space:
mode:
authorJorin Vogel <[email protected]>2017-08-02 14:25:05 +0200
committerBjørn Erik Pedersen <[email protected]>2017-08-03 15:57:51 +0200
commit81c13171a985b89f2af6682dbd1d4b8766cb9af7 (patch)
treedb39d78bbe6da0ea3f3dd3d2f94c7e1571ad8fd6 /tpl/os
parent9891c0fb0eb274b8a95b62c40070a87a6e04088c (diff)
downloadhugo-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 'tpl/os')
-rw-r--r--tpl/os/os.go6
1 files changed, 3 insertions, 3 deletions
diff --git a/tpl/os/os.go b/tpl/os/os.go
index fb60f87dd..c9ffb81cf 100644
--- a/tpl/os/os.go
+++ b/tpl/os/os.go
@@ -70,9 +70,9 @@ func readFile(fs *afero.BasePathFs, filename string) (string, error) {
return string(b), nil
}
-// ReadFilereads the file named by filename relative to the configured
-// WorkingDir. It returns the contents as a string. There is a upper size
-// limit set at 1 megabytes.
+// ReadFile reads the file named by filename relative to the configured WorkingDir.
+// It returns the contents as a string.
+// There is an upper size limit set at 1 megabytes.
func (ns *Namespace) ReadFile(i interface{}) (string, error) {
s, err := cast.ToStringE(i)
if err != nil {