Add comments

Author: lfcd85

kadai3-1/lfcd85/typinggame/typinggame.go

@@ -10,13 +10,16 @@ import (
 	"time"
 )
 
+// Words stores a slice of words which is used for the game.
 type Words []string
 
+// Game struct holds the words and the time limits of the game.
 type Game struct {
 	Words     Words
 	TimeLimit time.Duration
 }
 
+// Execute starts the game using standard input and output.
 func Execute(g Game) error {
 	g.run(inputChannel(os.Stdin), os.Stdout)
 	return nil

kadai3-1/lfcd85/words/words.go

@@ -8,6 +8,7 @@ import (
 	"github.com/hashicorp/go-multierror"
 )
 
+// Import reads the text file and returns the words for the typing game.
 func Import(path string) (typinggame.Words, error) {
 	var words typinggame.Words
 	var result error