E3V3A / TESTT

TEST -- This is only a test repo - nothing here
0 stars 0 forks source link

Change command json tags to correctly reflect spoken command #24

Open E3V3A opened 6 years ago

E3V3A commented 6 years ago

In the command file containing the spoken command text (that the module is reacting to) some of the variable names (or "tags") are not named according to what the command does. This is confusing.

{
  "UNSPEAKABLE" : "Sorry, I cannot pronounce this response.",
  "INVALID_FORMAT" : "Sorry, the question and answer based dialog is not supported in command mode. Please ask module developer.",
  "INVALID_COMMAND" : "Sorry, I cannot understand your command. Try again.",
  "ALIAS" : "This is alias of {command}",
  "CMD_HELP" : "help :command",
  "CMD_HELP_COMMAND_PROVIDER" : "This command is provided by {module}",
  "CMD_HELP_DESCRIPTION" : "This command could tell you the description of that command.",
  "CMD_HELP_COMMAND_EXAMPLE" : "Say command name after 'help' like this. 'help all modules'.",
  "CMD_LIST_COMMANDS" : "list all commands",
  "CMD_LIST_COMMANDS_DESCRIPTION" : "This command could tell the name of all commands available.",
  "CMD_LIST_COMMANDS_RESULT" : "These are available commands.",
  "CMD_LIST_MODULES" : "list all modules",
  "CMD_LIST_MODULES_DESCRIPTION" : "This command could tell the name of all modules installed currently.",
  "CMD_LIST_MODULES_RESULT" : "These are currently installed modules.",
  "CMD_HIDE_ALL_MODULES" : "hide all modules",
  "CMD_HIDE_ALL_MODULES_DESCRIPTION" : "This command could hide all modules from the screen of your magic mirror.",
  "CMD_HIDE_ALL_MODULES_RESULT" : "All modules will be hidden.",
  "CMD_SHOW_ALL_MODULES" : "show all modules",
  "CMD_SHOW_ALL_MODULES_DESCRIPTION" : "This command could show all modules which are hidden.",
  "CMD_SHOW_ALL_MODULES_RESULT" : "All modules will be shown.",
  "CMD_SAY" : "say :something",
  "CMD_SAY_DESCRIPTION" : "This command could speak anything which you want.",
  "CMD_REBOOT" : "reboot",
  "CMD_REBOOT_DESCRIPTION" : "This command could reboot the magic mirror instantly.",
  "CMD_SHUTDOWN" : "shut down",
  "CMD_SHUTDOWN_DESCRIPTION" : "This command could shutdown the magic mirror instantly.",
  "TELBOT_CMD_GA_DESCRIPTION" : "Send text to Google Assistant."
}

E.g. "CMD_LIST_COMMANDS" : "list all commands", should be better named: "CMD_LIST_ALL_COMMANDS" : "list all commands",.