bleep bloop

internal/storage/inmem.go

@@ -7,6 +7,11 @@ import (
 	"github.com/superseriousbusiness/gotosocial/internal/config"
 )
 
+// NewInMem returns an in-memory implementation of the Storage interface.
+// This is good for testing and whatnot but ***SHOULD ABSOLUTELY NOT EVER
+// BE USED IN A PRODUCTION SETTING***, because A) everything will be wiped out
+// if you restart the server and B) if you store lots of images your RAM use
+// will absolutely go through the roof.
 func NewInMem(c *config.Config, log *logrus.Logger) (Storage, error) {
 	return &inMemStorage{
 		stored: make(map[string][]byte),

internal/storage/local.go

@@ -5,6 +5,8 @@ import (
 	"github.com/superseriousbusiness/gotosocial/internal/config"
 )
 
+// NewLocal returns an implementation of the Storage interface that uses
+// the local filesystem for storing and retrieving files, attachments, etc.
 func NewLocal(c *config.Config, log *logrus.Logger) (Storage, error) {
 	return &localStorage{}, nil
 }

internal/storage/storage.go

@@ -16,8 +16,12 @@
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+// Package storage contains an interface and implementations for storing and retrieving files and attachments.
 package storage
 
+// Storage is an interface for storing and retrieving blobs
+// such as images, videos, and any other attachments/documents
+// that shouldn't be stored in a database.
 type Storage interface {
 	StoreFileAt(path string, data []byte) error
 	RetrieveFileFrom(path string) ([]byte, error)