edit comments and attributes in ConsoleCommands.fs.

SmoulderingBeachBallCLI/ConsoleCommands.fs

@@ -11,29 +11,29 @@
         let showEndOfCommandMessage = "[INFO.] Execution completed."
 
         [<ListCommand>]
+        [<Parameters "none">]
         [<Description
             "Display a text message indicating this program is running properly.">]
-        [<Parameters "none">]
         [<Usage "test">]
         let test () = "[SUCCESS] Smouldering Beach Ball CLI seems to be working."
 
         [<ListCommand>]
-        [<Description "Displays a list of available commands provided by this porgram.">]
         [<Parameters "none">]
+        [<Description "Displays a list of available commands provided by this porgram.">]
         [<Usage "help">]
         let help () = CW_Liaison().RequestHelpDocumentation("Commands")
 
         [<ListCommand>]
-        [<Description "Exits of out the program.">]
         [<Parameters "none">]
+        [<Description "Exits of out the program.">]
         [<Usage "exit">]
         let exit () = Environment.Exit (Environment.ExitCode)
 
         [<ListCommand>]
+        [<Parameters "(image-width: int) (image-height: int)" >]
         [<Description
             ("Saves an image to the desktop, using the default setting.\n" +
             "The user must specify the width and the height of the image.")>]
-        [<Parameters "(image-width: int) (image-height: int)" >]
         [<Usage "draw-default 500 500">]
         let ``draw-default`` imgWidth imgHeight =
             try
@@ -46,15 +46,15 @@
             | _ as ex -> ex.Message
 
         [<ListCommand>]
+        [<Parameters
+                ("(image-width: int) (image-height: int) (main-colour: string)" +
+                "(overlay-colour: string) (overlay-type:string) (file-path: string)")>]
         [<Description
-            ("Creates an image using the values specified by the user.\n" +
+            ("\nCreates an image using the values specified by the user.\n" +
             "To see a list of available colours use the 'list-colours' command.\n" +
-            "For the overlay-type you can enter either 'none', 'border' or 'full'." +
+            "For the overlay-type you can enter either 'none', 'border' or 'full'\n." +
             "For the file path, you can enter 'desktop' to save to the desktop." +
             "Otherwise, you must specify the whole path.")>]
-            [<Parameters
-                ("(image-width: int) (image-height: int) (main-colour: string)" +
-                "(overlay-colour: string) (overlay-type:string) (file-path: string)")>]
         [<Usage
             ("\ndraw-image 770 400 white black full desktop\n" +
             "draw-image 600 400 purple gray border C:/work/project-folder/images\n" +
@@ -69,6 +69,11 @@
             | :? ArgumentException as ex -> ex.Message
             | _ as ex -> ex.Message
 
+        [<ListCommand>]
+        [<Parameters "None">]
+        [<Description
+            "Lists out the colours this program uses to draw its images.">]
+        [<Usage "list-colours">]
         let ``list-colours`` () =
             printfn "[INFO.] Listing available colours..."
             for item in colourList do
@@ -78,10 +83,10 @@
         (* ALIASES 
         =======================================================================
         These command-methods will not show up in the help section. 
-        Before adding extra aliases, make sure the main version is as helpful
+        Before adding extra aliases, make sure the main version is as clear and
-        to someone new to the program as possible. Aliases should be treated as
+        helpful to someone new to the program as possible. Aliases should be
-        commands for experienced users and documented on the wiki, hosted 
+        treated as commands for experienced users and documented on the wiki,
-        alongside the repository on GitHub.
+        hosted alongside the repository on GitHub.
         URL: https://github.com/CraigOates/Smouldering-Beach-Ball/wiki *)
 
         let dd imgWidth imgHeight =