Improve MultiCLI output

Author: timothycrosley

CHANGELOG.md

@@ -14,6 +14,7 @@ Changelog
 ### 2.6.0 - August 28, 2019
 - Improved CLI multiple behaviour with empty defaults
 - Improved CLI type output for built-in types
+- Improved MultiCLI base documentation
 
 ### 2.5.6 - June 20, 2019
 - Fixed issue #815: map_params() causes api documentation to lose param type information

examples/cli_object.py

@@ -9,10 +9,12 @@ class GIT(object):
 
     @hug.object.cli
     def push(self, branch="master"):
+        """Push the latest to origin"""
         return "Pushing {}".format(branch)
 
     @hug.object.cli
     def pull(self, branch="master"):
+        """Pull in the latest from origin"""
         return "Pulling {}".format(branch)
 
 

hug/api.py

@@ -469,10 +469,12 @@ def output_format(self, formatter):
         self._output_format = formatter
 
     def __str__(self):
-        return "{0}\n\nAvailable Commands:{1}\n".format(
-            self.api.doc or self.api.name, "\n\n\t- " + "\n\t- ".join(self.commands.keys())
-        )
-
+        output = "{0}\n\nAvailable Commands:\n\n".format(self.api.doc or self.api.name)
+        for command_name, command in self.commands.items():
+            command_string = " - {}{}".format(command_name, ": " + command.parser.description.replace("\n", " ") if command.parser.description else "")
+            output += (command_string[:77] + "..." if len(command_string) > 80 else command_string)
+            output += "\n"
+        return output
 
 class ModuleSingleton(type):
     """Defines the module level __hug__ singleton"""