Println cleanup (ardanlabs#247)

* address println builtin usage

* don't confuse function with builtin

* code should use cwd path

* should have newline because we're iterating

* fix package name

* simpler speak print formatting

* nitpick: use tab characters

Author: flyinprogrammer

topics/go/concurrency/channels/advanced/example1/example1.go

@@ -6,6 +6,8 @@
 // https://golang.org/ref/mem#tmp_7
 package main
 
+import "fmt"
+
 func main() {
 	unBuffered()
 	buffered()
@@ -27,7 +29,7 @@ func unBuffered() {
 	c <- 0
 
 	// We are guaranteed to print "hello, world".
-	println(a)
+	fmt.Println(a)
 }
 
 // With buffered channels, the send happens before the corresponding receive.
@@ -45,7 +47,7 @@ func buffered() {
 	<-c
 
 	// We are guaranteed to print "hello, world".
-	println(a)
+	fmt.Println(a)
 }
 
 // With both types of channels, a close happens before the corresponding receive.
@@ -63,5 +65,5 @@ func closed() {
 	<-c
 
 	// We are guaranteed to print "hello, world".
-	println(a)
+	fmt.Println(a)
 }

topics/go/design/composition/grouping/example1/example1.go

@@ -19,10 +19,11 @@ type Animal struct {
 // Speak provides generic behavior for all animals and
 // how they speak.
 func (a *Animal) Speak() {
-	fmt.Println("UGH!",
-		"My name is", a.Name,
-		", it is", a.IsMammal,
-		"I am a mammal")
+	fmt.Printf(
+		"UGH! My name is %s, it is %t I am a mammal\n",
+		a.Name,
+		a.IsMammal,
+	)
 }
 
 // Dog contains everything an Animal is but specific
@@ -34,10 +35,12 @@ type Dog struct {
 
 // Speak knows how to speak like a dog.
 func (d *Dog) Speak() {
-	fmt.Println("Woof!",
-		"My name is", d.Name,
-		", it is", d.IsMammal,
-		"I am a mammal with a pack factor of", d.PackFactor)
+	fmt.Printf(
+		"Woof! My name is %s, it is %t I am a mammal with a pack factor of %d.\n",
+		d.Name,
+		d.IsMammal,
+		d.PackFactor,
+	)
 }
 
 // Cat contains everything an Animal is but specific
@@ -49,10 +52,12 @@ type Cat struct {
 
 // Speak knows how to speak like a cat.
 func (c *Cat) Speak() {
-	fmt.Println("Meow!",
-		"My name is", c.Name,
-		", it is", c.IsMammal,
-		"I am a mammal with a climb factor of", c.ClimbFactor)
+	fmt.Printf(
+		"Meow! My name is %s, it is %t I am a mammal with a climb factor of %d.\n",
+		c.Name,
+		c.IsMammal,
+		c.ClimbFactor,
+	)
 }
 
 func main() {

topics/go/design/composition/grouping/example2/example2.go

@@ -27,10 +27,12 @@ type Dog struct {
 // This makes a Dog now part of a group of concrete
 // types that know how to speak.
 func (d *Dog) Speak() {
-	fmt.Println("Woof!",
-		"My name is", d.Name,
-		", it is", d.IsMammal,
-		"I am a mammal with a pack factor of", d.PackFactor)
+	fmt.Printf(
+		"Woof! My name is %s, it is %t I am a mammal with a pack factor of %d.\n",
+		d.Name,
+		d.IsMammal,
+		d.PackFactor,
+	)
 }
 
 // Cat contains everything a Cat needs.
@@ -44,10 +46,12 @@ type Cat struct {
 // This makes a Cat now part of a group of concrete
 // types that know how to speak.
 func (c *Cat) Speak() {
-	fmt.Println("Meow!",
-		"My name is", c.Name,
-		", it is", c.IsMammal,
-		"I am a mammal with a climb factor of", c.ClimbFactor)
+	fmt.Printf(
+		"Meow! My name is %s, it is %t I am a mammal with a climb factor of %d.\n",
+		c.Name,
+		c.IsMammal,
+		c.ClimbFactor,
+	)
 }
 
 func main() {

topics/go/design/error_handling/example4/example4.go

@@ -1,8 +1,8 @@
 // All material is licensed under the Apache License Version 2.0, January 2004
 // http://www.apache.org/licenses/LICENSE-2.0
 
-// Package example5 provides code to show how to implement behavior as context.
-package example5
+// Package example4 provides code to show how to implement behavior as context.
+package example4
 
 import (
 	"bufio"

topics/go/exercises/chatbot/exercise/main.go

@@ -19,10 +19,10 @@ func main() {
 
 	// Print something to welcome users and tell them what they can ask about.
 	fmt.Println(`Welcome to my chatbot! Exit with ctrl-c or type "exit" or "quit".`)
-	fmt.Println(`You can ask me about:`)
-	fmt.Println(`	The weather.`)
-	fmt.Println(`	How I'm feeling.`)
-	fmt.Println(`	The game last night.`)
+	fmt.Println("You can ask me about:")
+	fmt.Println("\tThe weather.")
+	fmt.Println("\tHow I'm feeling.")
+	fmt.Println("\tThe game last night.")
 
 	// Print a > to prompt the user to type something. Don't use Println for this.
 	fmt.Print("> ")

topics/go/language/embedding/exercises/exercise1/exercise1.go

@@ -58,7 +58,7 @@ func main() {
 	// Range of each haystack value and check the term.
 	for _, hs := range haystack {
 		if hs.find(needle) {
-			fmt.Printf("FOUND: %+v", hs)
+			fmt.Printf("FOUND: %+v\n", hs)
 		}
 	}
 }

topics/go/packages/encoding/example2/example2.go

@@ -38,7 +38,7 @@ type (
 func main() {
 
 	// Open the file.
-	file, err := os.Open("./topics/go/packages/encoding/example2/data.json")
+	file, err := os.Open("data.json")
 	if err != nil {
 		fmt.Println("Open File", err)
 		return

topics/go/packages/encoding/exercises/exercise1/exercise1.go

@@ -23,7 +23,7 @@ type user struct {
 func main() {
 
 	// Open the file.
-	file, err := os.Open("./topics/go/packages/encoding/exercises/exercise1/data.json")
+	file, err := os.Open("data.json")
 	if err != nil {
 		fmt.Println("Open File", err)
 		return

topics/go/packages/io/advanced/example1/example1.go

@@ -21,7 +21,7 @@ import (
 func main() {
 
 	// Open the file for reading.
-	file, err := os.Open("./topics/go/packages/io/advanced/example1/data.json")
+	file, err := os.Open("data.json")
 	if err != nil {
 		fmt.Println("Open File", err)
 		return

topics/web/serializers/example4/main.go

@@ -26,8 +26,8 @@ func main() {
 		log.Fatal(err)
 	}
 
-	print("Zero value User", b)
-	print("Note 'roles' is null", nil)
+	printMsgData("Zero value User", b)
+	printMsgData("Note 'roles' is null", nil)
 
 	// Initialize roles for an otherwise zeroed User
 	u := User{
@@ -39,8 +39,8 @@ func main() {
 		log.Fatal(err)
 	}
 
-	print("User with empty roles slice", b)
-	print("Note 'roles' is [] not null", nil)
+	printMsgData("User with empty roles slice", b)
+	printMsgData("Note 'roles' is [] not null", nil)
 
 	// Fill in data for user
 	u = User{
@@ -54,11 +54,11 @@ func main() {
 		log.Fatal(err)
 	}
 
-	print("User with data", b)
+	printMsgData("User with data", b)
 
 	fmt.Println("\nNote in all examples 'email' is missing.")
 }
 
-func print(msg string, data []byte) {
+func printMsgData(msg string, data []byte) {
 	fmt.Printf("%30s | %s\n", msg, string(data))
 }