From 67a9d9e9d7a0a15a7af9fbe38f00886bd0090e26 Mon Sep 17 00:00:00 2001
From: Elias Naur <mail@eliasnaur.com>
Date: Mon, 18 May 2020 17:52:54 +0200
Subject: [PATCH] io/system: improve FrameEvent documentation

Phrase stolen from Egon's architecture document.

Replace tabs with spaces in the example while here.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
---
 io/system/system.go | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)

diff --git a/io/system/system.go b/io/system/system.go
index 97f491f8..ac562633 100644
--- a/io/system/system.go
+++ b/io/system/system.go
@@ -14,7 +14,8 @@ import (
 )
 
 // A FrameEvent requests a new frame in the form of a list of
-// operations.
+// operations that describes what to display and how to handle
+// input.
 type FrameEvent struct {
 	Config Config
 	// Size is the dimensions of the window.
@@ -33,14 +34,14 @@ type FrameEvent struct {
 	//
 	// Example:
 	//
-	//	var w *app.Window
-	//	var frame *op.Ops
-	// 	for e := range w.Events() {
-	//  	if e, ok := e.(system.FrameEvent); ok {
-	//			// Call frame.Reset and manipulate images for ImageOps
-	//			// here.
-	//			e.Frame(frame)
-	//  	}
+	//  var w *app.Window
+	//  var frame *op.Ops
+	//  for e := range w.Events() {
+	//      if e, ok := e.(system.FrameEvent); ok {
+	//          // Call frame.Reset and manipulate images for ImageOps
+	//          // here.
+	//          e.Frame(frame)
+	//      }
 	//  }
 	Frame func(frame *op.Ops)
 	// Queue supplies the events for event handlers.