refactor: Removing captain obvious comment

Signed-off-by: Vincent Boutour <[email protected]>

pkg/crud/delete.go

@@ -52,7 +52,6 @@ func (a App) Delete(w http.ResponseWriter, r *http.Request, request provider.Req
 	a.rendererApp.Redirect(w, r, fmt.Sprintf("?d=%s", request.Display), renderer.NewSuccessMessage("%s successfully deleted", info.Name))
 }
 
-// Delete given path from filesystem
 func (a App) DeleteSavedSearch(w http.ResponseWriter, r *http.Request, request provider.Request) {
 	if !request.CanEdit {
 		a.error(w, r, request, model.WrapForbidden(ErrNotAuthorized))

pkg/crud/list.go

@@ -158,7 +158,6 @@ func (a App) enrichThumbnail(ctx context.Context, directoryAggregate provider.Ag
 	return
 }
 
-// Download content of a directory into a streamed zip
 func (a App) Download(w http.ResponseWriter, r *http.Request, request provider.Request, items []absto.Item) {
 	zipWriter := zip.NewWriter(w)
 	defer func() {

pkg/fibr/renderer.go

@@ -13,7 +13,6 @@ import (
 	"github.com/ViBiOh/httputils/v4/pkg/renderer"
 )
 
-// FuncMap is the map of function available in templates
 var FuncMap = template.FuncMap{
 	"rebuildPaths": func(parts []string, index int) string {
 		return fmt.Sprintf("/%s/", strings.Join(parts[:index+1], "/"))
@@ -63,7 +62,6 @@ var FuncMap = template.FuncMap{
 	},
 }
 
-// TemplateFunc for rendering GUI
 func (a App) TemplateFunc(w http.ResponseWriter, r *http.Request) (renderer.Page, error) {
 	if !isMethodAllowed(r) {
 		return renderer.Page{}, model.WrapMethodNotAllowed(errors.New("you lack of method for calling me"))

pkg/geo/geo.go

@@ -51,7 +51,6 @@ func NewPosition(lon, lat float64) Position {
 	}
 }
 
-// MarshalJSON marshals the position as an array.
 func (p Position) MarshalJSON() ([]byte, error) {
 	return []byte(fmt.Sprintf("[%f,%f]", p.Longitude, p.Latitude)), nil
 }

pkg/provider/event.go

@@ -20,32 +20,21 @@ import (
 	"go.opentelemetry.io/otel/trace"
 )
 
-// EventType is the enumeration of event that can happen
 type EventType uint
 
-// EventProducer is a func that push an event
 type EventProducer func(Event) error
 
-// EventConsumer is a func that consume an event
 type EventConsumer func(context.Context, Event)
 
-// Renamer is a func that rename an item
 type Renamer func(context.Context, absto.Item, absto.Item) error
 
 const (
-	// UploadEvent occurs when someone upload a file
 	UploadEvent EventType = iota
-	// CreateDir occurs when a directory is created
 	CreateDir
-	// RenameEvent occurs when an item is renamed
 	RenameEvent
-	// DeleteEvent occurs when an item is deleted
 	DeleteEvent
-	// StartEvent occurs when fibr start
 	StartEvent
-	// AccessEvent occurs when content is accessed
 	AccessEvent
-	// DescriptionEvent occurs when a description is added
 	DescriptionEvent
 )
 
@@ -65,7 +54,6 @@ func (et EventType) String() string {
 	return eventTypeValues[et]
 }
 
-// MarshalJSON marshals the enum as a quoted json string
 func (et EventType) MarshalJSON() ([]byte, error) {
 	buffer := bytes.NewBufferString(`"`)
 	buffer.WriteString(et.String())
@@ -100,7 +88,6 @@ type Event struct {
 	Type         EventType         `json:"type"`
 }
 
-// IsForcedFor check if event is forced for given key
 func (e Event) IsForcedFor(key string) bool {
 	force := e.GetMetadata("force")
 
@@ -267,7 +254,6 @@ func NewAccessEvent(item absto.Item, r *http.Request) Event {
 	}
 }
 
-// EventBus describes a channel for exchanging Event
 type EventBus struct {
 	tracer  trace.Tracer
 	counter *prometheus.CounterVec

pkg/provider/provider.go

@@ -7,11 +7,8 @@ import (
 )
 
 const (
-	// MetadataDirectoryName directory where metadata are stored
 	MetadataDirectoryName = "/.fibr"
-
-	// MaxConcurrency defines how many concurrent task can be launch in parallel when possible
-	MaxConcurrency = uint64(6)
+	MaxConcurrency        = uint64(6)
 )
 
 var (

pkg/provider/request.go

@@ -12,17 +12,12 @@ import (
 type Display string
 
 var (
-	// GridDisplay format
-	GridDisplay Display = "grid"
-	// ListDisplay format
-	ListDisplay Display = "list"
-	// StoryDisplay format
+	GridDisplay  Display = "grid"
+	ListDisplay  Display = "list"
 	StoryDisplay Display = "story"
 
-	// DefaultDisplay format
 	DefaultDisplay = GridDisplay
 
-	// LayoutPathsCookieName for saving preferences
 	LayoutPathsCookieName = "layout_paths"
 
 	preferencesPathSeparator = "|"

pkg/provider/storage.go

@@ -17,7 +17,6 @@ func greaterTime(first, second time.Time) bool {
 	return first.After(second)
 }
 
-// ByHybridSort implements Sorter by type then modification time
 type ByHybridSort []absto.Item
 
 func (a ByHybridSort) Len() int {

pkg/share/event.go

@@ -11,7 +11,6 @@ import (
 	"github.com/ViBiOh/httputils/v4/pkg/logger"
 )
 
-// EventConsumer handle event pushed to the event bus
 func (a *App) EventConsumer(ctx context.Context, e provider.Event) {
 	switch e.Type {
 	case provider.RenameEvent:

pkg/thumbnail/directory.go

@@ -6,12 +6,10 @@ import (
 	absto "github.com/ViBiOh/absto/pkg/model"
 )
 
-// ListDirLarge return all thumbnails for large size for a given directory
 func (a App) ListDirLarge(ctx context.Context, item absto.Item) (map[string]absto.Item, error) {
 	return a.listDirectoryForScale(ctx, item, a.largeStorageApp)
 }
 
-// ListDir return all thumbnails for a given directory
 func (a App) ListDir(ctx context.Context, item absto.Item) (map[string]absto.Item, error) {
 	return a.listDirectoryForScale(ctx, item, a.smallStorageApp)
 }

pkg/thumbnail/event.go

@@ -9,7 +9,6 @@ import (
 	"github.com/ViBiOh/httputils/v4/pkg/logger"
 )
 
-// EventConsumer handle event pushed to the event bus
 func (a App) EventConsumer(ctx context.Context, e provider.Event) {
 	if a.vithRequest.IsZero() && a.amqpClient == nil {
 		return
@@ -31,7 +30,6 @@ func (a App) EventConsumer(ctx context.Context, e provider.Event) {
 	}
 }
 
-// Rename thumbnail of an item
 func (a App) Rename(ctx context.Context, old, new absto.Item) error {
 	if old.IsDir {
 		return nil

pkg/thumbnail/stream.go

@@ -14,7 +14,6 @@ import (
 	"github.com/ViBiOh/vith/pkg/model"
 )
 
-// HasStream checks if given item has a streamable version
 func (a App) HasStream(ctx context.Context, item absto.Item) bool {
 	_, err := a.Info(ctx, getStreamPath(item))
 	return err == nil

pkg/thumbnail/thumbnail.go

@@ -27,10 +27,7 @@ import (
 	"go.opentelemetry.io/otel/trace"
 )
 
-const (
-	// SmallSize is the square size of each thumbnail generated
-	SmallSize uint64 = 150
-)
+const SmallSize uint64 = 150
 
 var cacheDuration = fmt.Sprintf("private, max-age=%.0f", (time.Minute * 5).Seconds())
 
@@ -146,12 +143,10 @@ func New(config Config, storage absto.Storage, redisClient redis.Client, prometh
 	return app, nil
 }
 
-// LargeThumbnailSize give large thumbnail size
 func (a App) LargeThumbnailSize() uint64 {
 	return a.largeSize
 }
 
-// Stream check if stream is present and serve it
 func (a App) Stream(w http.ResponseWriter, r *http.Request, item absto.Item) {
 	reader, err := a.storageApp.ReadFrom(r.Context(), getStreamPath(item))
 	if err != nil {
@@ -170,7 +165,6 @@ func (a App) Stream(w http.ResponseWriter, r *http.Request, item absto.Item) {
 	http.ServeContent(w, r, item.Name, item.Date, reader)
 }
 
-// Serve check if thumbnail is present and serve it
 func (a App) Serve(w http.ResponseWriter, r *http.Request, item absto.Item) {
 	if !a.CanHaveThumbnail(item) {
 		w.WriteHeader(http.StatusNoContent)
@@ -209,7 +203,6 @@ func (a App) Serve(w http.ResponseWriter, r *http.Request, item absto.Item) {
 	http.ServeContent(w, r, baseName, item.Date, reader)
 }
 
-// List return all thumbnails in a base64 form
 func (a App) List(w http.ResponseWriter, r *http.Request, item absto.Item, items []absto.Item) {
 	if len(items) == 0 {
 		w.WriteHeader(http.StatusNoContent)