Merge pull request #111 from shomali11/examples

Converted Example to Examples
slack-io · Jul 26, 2022 · e3aedd3 · e3aedd3
2 parents a218a1f + a1936b5
commit e3aedd3
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -127,7 +127,7 @@ func main() {
 
 	definition := &slacker.CommandDefinition{
 		Description: "Ping!",
-		Example:     "ping",
+		Examples:    []string{"ping"},
 		Handler: func(botCtx slacker.BotContext, request slacker.Request, response slacker.ResponseWriter) {
 			response.Reply("pong", slacker.WithThreadReply(true))
 		},
@@ -165,7 +165,7 @@ func main() {
 
 	bot.Command("echo {word}", &slacker.CommandDefinition{
 		Description: "Echo a word!",
-		Example:     "echo hello",
+		Examples:    []string{"echo hello"},
 		Handler: func(botCtx slacker.BotContext, request slacker.Request, response slacker.ResponseWriter) {
 			word := request.Param("word")
 			response.Reply(word)
@@ -174,7 +174,7 @@ func main() {
 
 	bot.Command("say <sentence>", &slacker.CommandDefinition{
 		Description: "Say a sentence!",
-		Example:     "say hello there everyone!",
+		Examples:    []string{"say hello there everyone!"},
 		Handler: func(botCtx slacker.BotContext, request slacker.Request, response slacker.ResponseWriter) {
 			sentence := request.Param("sentence")
 			response.Reply(sentence)
@@ -212,7 +212,7 @@ func main() {
 
 	definition := &slacker.CommandDefinition{
 		Description: "Repeat a word a number of times!",
-		Example:     "repeat hello 10",
+		Examples:    []string{"repeat hello 10"},
 		Handler: func(botCtx slacker.BotContext, request slacker.Request, response slacker.ResponseWriter) {
 			word := request.StringParam("word", "Hello!")
 			number := request.IntegerParam("number", 1)
@@ -755,7 +755,7 @@ func main() {
 
 	bot.Command("echo {word}", &slacker.CommandDefinition{
 		Description: "Echo a word!",
-		Example:     "echo hello",
+		Examples:    []string{"echo hello"},
 		Handler: func(botCtx slacker.BotContext, request slacker.Request, response slacker.ResponseWriter) {
 			word := request.Param("word")
 			response.Reply(word)

diff --git a/command.go b/command.go
@@ -10,7 +10,7 @@ import (
 // CommandDefinition structure contains definition of the bot command
 type CommandDefinition struct {
 	Description       string
-	Example           string
+	Examples          []string
 	BlockID           string
 	AuthorizationFunc func(botCtx BotContext, request Request) bool
 	Handler           func(botCtx BotContext, request Request, response ResponseWriter)

diff --git a/examples/14/example14.go b/examples/14/example14.go
@@ -34,7 +34,7 @@ func main() {
 
 	bot.Command("echo {word}", &slacker.CommandDefinition{
 		Description: "Echo a word!",
-		Example:     "echo hello",
+		Examples:    []string{"echo hello"},
 		Handler: func(botCtx slacker.BotContext, request slacker.Request, response slacker.ResponseWriter) {
 			word := request.Param("word")
 			response.Reply(word)

diff --git a/examples/2/example2.go b/examples/2/example2.go
@@ -13,7 +13,7 @@ func main() {
 
 	definition := &slacker.CommandDefinition{
 		Description: "Ping!",
-		Example:     "ping",
+		Examples:    []string{"ping"},
 		Handler: func(botCtx slacker.BotContext, request slacker.Request, response slacker.ResponseWriter) {
 			response.Reply("pong", slacker.WithThreadReply(true))
 		},

diff --git a/examples/3/example3.go b/examples/3/example3.go
@@ -13,7 +13,7 @@ func main() {
 
 	bot.Command("echo {word}", &slacker.CommandDefinition{
 		Description: "Echo a word!",
-		Example:     "echo hello",
+		Examples:    []string{"echo hello"},
 		Handler: func(botCtx slacker.BotContext, request slacker.Request, response slacker.ResponseWriter) {
 			word := request.Param("word")
 			response.Reply(word)
@@ -22,7 +22,7 @@ func main() {
 
 	bot.Command("say <sentence>", &slacker.CommandDefinition{
 		Description: "Say a sentence!",
-		Example:     "say hello there everyone!",
+		Examples:    []string{"say hello there everyone!"},
 		Handler: func(botCtx slacker.BotContext, request slacker.Request, response slacker.ResponseWriter) {
 			sentence := request.Param("sentence")
 			response.Reply(sentence)

diff --git a/examples/4/example4.go b/examples/4/example4.go
@@ -13,7 +13,7 @@ func main() {
 
 	definition := &slacker.CommandDefinition{
 		Description: "Repeat a word a number of times!",
-		Example:     "repeat hello 10",
+		Examples:    []string{"repeat hello 10"},
 		Handler: func(botCtx slacker.BotContext, request slacker.Request, response slacker.ResponseWriter) {
 			word := request.StringParam("word", "Hello!")
 			number := request.IntegerParam("number", 1)

diff --git a/slacker.go b/slacker.go
@@ -285,8 +285,8 @@ func (s *Slacker) defaultHelp(botCtx BotContext, request Request, response Respo
 
 		helpMessage += newLine
 
-		if len(command.Definition().Example) > 0 {
-			helpMessage += fmt.Sprintf(quoteMessageFormat, command.Definition().Example) + newLine
+		for _, example := range command.Definition().Examples {
+			helpMessage += fmt.Sprintf(quoteMessageFormat, example) + newLine
 		}
 	}