#1322 add volume-set-note docs

Author: ATGE

SoftLayer/CLI/block/list.py

@@ -79,7 +79,7 @@ def cli(env, sortby, columns, datacenter, username, storage_type):
     table = formatting.Table(columns.columns)
     table.sortby = sortby
 
-    reduce_notes(block_volumes)
+    _reduce_notes(block_volumes)
 
     for block_volume in block_volumes:
         table.add_row([value or formatting.blank()
@@ -88,7 +88,11 @@ def cli(env, sortby, columns, datacenter, username, storage_type):
     env.fout(table)
 
 
-def reduce_notes(block_volumes):
+def _reduce_notes(block_volumes):
+    """Reduces the size of the notes in a volume list.
+
+    :param block_volumes: An list of block volumes
+    """
     for block_volume in block_volumes:
         if len(block_volume.get('notes', '')) > DEFAULT_NOTES_SIZE:
             shortened_notes = block_volume['notes'][:DEFAULT_NOTES_SIZE]

SoftLayer/CLI/file/list.py

@@ -77,7 +77,7 @@ def cli(env, sortby, columns, datacenter, username, storage_type):
     table = formatting.Table(columns.columns)
     table.sortby = sortby
 
-    reduce_notes(file_volumes)
+    _reduce_notes(file_volumes)
 
     for file_volume in file_volumes:
         table.add_row([value or formatting.blank()
@@ -86,7 +86,11 @@ def cli(env, sortby, columns, datacenter, username, storage_type):
     env.fout(table)
 
 
-def reduce_notes(file_volumes):
+def _reduce_notes(file_volumes):
+    """Reduces the size of the notes in a volume list.
+
+    :param file_volumes: An list of file volumes
+    """
     for file_volume in file_volumes:
         if len(file_volume.get('notes', '')) > DEFAULT_NOTES_SIZE:
             shortened_notes = file_volume['notes'][:DEFAULT_NOTES_SIZE]

docs/cli/block.rst

@@ -138,3 +138,7 @@ Block Commands
 .. click:: SoftLayer.CLI.block.convert:cli
     :prog: block volume-convert
     :show-nested:
+
+.. click:: SoftLayer.CLI.block.set_note:cli
+    :prog: block volume-set-note
+    :show-nested:

docs/cli/file.rst

@@ -117,4 +117,8 @@ File Commands
 
 .. click:: SoftLayer.CLI.file.convert:cli
     :prog: file volume-convert
+    :show-nested:
+
+.. click:: SoftLayer.CLI.file.set_note:cli
+    :prog: file volume-set-note
     :show-nested: