add doc comments for loader

johnfercher · Oct 23, 2024 · ab93d26 · ab93d26
1 parent b4a38b2
commit ab93d26
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/pkg/processor/core/core.go b/pkg/processor/core/core.go
@@ -14,6 +14,8 @@ type Deserializer interface {
 	Deserialize(document string) (map[string]interface{}, error)
 }
 
+// Takes a path and returns its bytes
+// path may be file path or url
 type Loader interface {
 	Load(path string) ([]byte, error)
 }
diff --git a/pkg/processor/loader/loader.go b/pkg/processor/loader/loader.go
@@ -1,5 +1,3 @@
-// loader is responsible for loading assets (images, fonts)
-// into memory for templates and documents
 package loader
 
 import (
@@ -19,7 +17,9 @@ func NewLoader() *loader {
 	return &loader{}
 }
 
-func (localloader *loader) Load(path string) ([]byte, error) {
+// Load takes the path/url/uri of an asset (image, font)
+// and returns its contents.
+func (l *loader) Load(path string) ([]byte, error) {
 	ext := getExt(path)
 	if _, ok := validExts[ext]; !ok {
 		return nil, errors.Wrap(ErrUnsupportedExtension, ext)