From 7f47791c7b972009faa77b0fd12fc91fd4105317 Mon Sep 17 00:00:00 2001 From: Ivan Marquez Date: Mon, 9 Sep 2019 20:46:30 -0400 Subject: [PATCH] DOC: adds doc comments to exported functions Adds comments to console.go exported functions. --- console/console.go | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/console/console.go b/console/console.go index 9bbb2c5..d267d24 100644 --- a/console/console.go +++ b/console/console.go @@ -2,10 +2,11 @@ package console import ( "fmt" - ui "github.com/gizak/termui/v3" "log" "os" "time" + + ui "github.com/gizak/termui/v3" ) const ( @@ -38,10 +39,13 @@ func Init() { } } +// Close function calls Close from termui package, +// which closes termbox-go func Close() { ui.Close() } +// Exit function exits the program successfully func Exit(message string) { if len(message) > 0 { println(message)