From 251f944f12cc4d30f2914d4b0b5f6630f231db6f Mon Sep 17 00:00:00 2001
From: Christian Rocha <christian@rocha.is>
Date: Wed, 13 May 2020 16:06:15 -0400
Subject: [PATCH] Spinner doc comments

---
 pager/pager.go     |  8 ++++++++
 spinner/spinner.go | 24 +++++++++++++++++++-----
 2 files changed, 27 insertions(+), 5 deletions(-)

diff --git a/pager/pager.go b/pager/pager.go
index 487558b..197622a 100644
--- a/pager/pager.go
+++ b/pager/pager.go
@@ -38,6 +38,14 @@ type Model struct {
 	lines []string
 }
 
+func (m *Model) PageUp() {
+	m.Y = max(0, m.Y-m.Height)
+}
+
+func (m *Model) PageDown() {
+	m.Y = min(len(m.lines)-m.Height, m.Y+m.Height)
+}
+
 // Content adds text content to the model
 func (m *Model) Content(s string) {
 	s = strings.TrimSpace(s)
diff --git a/spinner/spinner.go b/spinner/spinner.go
index 678a929..7a5008d 100644
--- a/spinner/spinner.go
+++ b/spinner/spinner.go
@@ -7,7 +7,7 @@ import (
 	"github.com/muesli/termenv"
 )
 
-// Spinner denotes a type of spinner
+// Spinner is a set of frames used in animating the spinner.
 type Spinner = int
 
 // Available types of spinners
@@ -29,15 +29,29 @@ var (
 // Model contains the state for the spinner. Use NewModel to create new models
 // rather than using Model as a struct literal.
 type Model struct {
-	Type            Spinner
-	FPS             int
+
+	// Type is the set of frames to use. See Spinner.
+	Type Spinner
+
+	// FPS is the speed at which the ticker should tick
+	FPS int
+
+	// ForegroundColor sets the background color of the spinner. It can be a
+	// hex code or one of the 256 ANSI colors. If the terminal emulator can't
+	// doesn't support the color specified it will automatically degrade
+	// (per github.com/muesli/termenv).
 	ForegroundColor string
+
+	// BackgroundColor sets the background color of the spinner. It can be a
+	// hex code or one of the 256 ANSI colors. If the terminal emulator can't
+	// doesn't support the color specified it will automatically degrade
+	// (per github.com/muesli/termenv).
 	BackgroundColor string
 
 	// CustomMsgFunc can be used to a custom message on tick. This can be
 	// useful when you have spinners in different parts of your application and
-	// want to differentiate the messages for clarity. If nil this setting is
-	// ignored.
+	// want to differentiate between the messages for clarity and simplicity.
+	// If nil, this setting is ignored.
 	CustomMsgFunc func() boba.Msg
 
 	frame int