Merge pull request #842 from flavio-fernandes/first_example.merge

doc: improve first example of slcli

Author: allmightyspiff

docs/dev/cli.rst

@@ -13,28 +13,31 @@ For the first example, we can create `slcli table-example` by creating the follo
 
 ::
 
+    """A formatting table example."""
+    from SoftLayer.CLI import environment
     from SoftLayer.CLI import formatting
 
     import click
 
 
     @click.command()
-    def cli():
+    @environment.pass_env
+    def cli(env):
         """This returns an table that highlights how tables are output"""
         # create a table with two columns: col1, col2
-        t = formatting.Table(['col1', 'col2'])
+        table = formatting.Table(['col1', 'col2'])
 
         # align the data facing each other
         # valid values are r, c, l for right, center, left
         # note, these are suggestions based on the format chosen by the user
-        t.align['col1'] = 'r'
-        t.align['col2'] = 'l'
+        table.align['col1'] = 'r'
+        table.align['col2'] = 'l'
 
         # add rows
-        t.add_row(['test', 'test'])
-        t.add_row(['test2', 'test2'])
+        table.add_row(['test', 'test'])
+        table.add_row(['test2', 'test2'])
 
-        return t
+        env.fout(table)
 
 Then we need to register it so that `slcli table-example` will know to route to this new module. We do that by adding ALL_ROUTES in SoftLayer/CLI/routes.py to include the following: