finish writing code comments

internal/processing/timeline/home.go

@@ -28,7 +28,8 @@ import (
 	"github.com/superseriousbusiness/gotosocial/internal/paging"
 )
 
-// HomeTimelineGet ...
+// HomeTimelineGet gets a pageable timeline of statuses
+// in the home timeline of the requesting account.
 func (p *Processor) HomeTimelineGet(
 	ctx context.Context,
 	requester *gtsmodel.Account,

internal/processing/timeline/list.go

@@ -30,7 +30,8 @@ import (
 	"github.com/superseriousbusiness/gotosocial/internal/paging"
 )
 
-// ListTimelineGet ...
+// ListTimelineGet gets a pageable timeline of statuses
+// in the list timeline of ID by the requesting account.
 func (p *Processor) ListTimelineGet(
 	ctx context.Context,
 	requester *gtsmodel.Account,

internal/processing/timeline/public.go

@@ -27,7 +27,11 @@ import (
 	"github.com/superseriousbusiness/gotosocial/internal/paging"
 )
 
-// PublicTimelineGet ...
+// PublicTimelineGet gets a pageable timeline of public statuses
+// for the given requesting account. It ensures that each status
+// in timeline is visible to the account before returning it.
+//
+// The local argument limits this to local-only statuses.
 func (p *Processor) PublicTimelineGet(
 	ctx context.Context,
 	requester *gtsmodel.Account,

internal/processing/timeline/tag.go

@@ -66,7 +66,8 @@ func (p *Processor) TagTimelineGet(
 		// account.
 		requester,
 
-		// No cache.
+		// No
+		// cache.
 		nil,
 
 		// Current

internal/processing/timeline/timeline.go

@@ -110,6 +110,9 @@ func (p *Processor) getStatusTimeline(
 
 	// Load status page via timeline cache, also
 	// getting lo, hi values for next, prev pages.
+	//
+	// NOTE: this safely handles the case of a nil
+	// input timeline, i.e. uncached timeline type.
 	apiStatuses, lo, hi, err := timeline.Load(ctx,
 
 		// Status page