Merge pull request #305 from dixyushi/update-doc-executeCommand

Update function execute command

Author: GuentherJulian

documentation/Functions.md

@@ -158,14 +158,36 @@ Note: No background scripts are running and Katacoda user don't have to manually
 ***
 
 ### executeCommand <a name="executeCommand"></a>
+This function is used when you want to use a bash (or powershell/cmd on windows) command. 
+
 #### parameter 
-1. The command that will be executed on Windows
-2. The command that will be executed on Linux
-3. Json-object with optional fields
-   * (Optional) Directory where the command will be executed, if not in current directory (relative to workspace){"dir": string}
-   * (Optional) Synchronous or asynchronous process. Use asynchronous when starting a server. Default is synchronous. {"asynchronous": boolean}
-   * (Optional) Array of arguments {"args": string[]}
-4. Assert information needed if you start a server to check server availability. Only required when you start a asynchronous server. 
+This function consists of four parameters.
+
+1. First parameter:
+    - **Required**
+    - **Type**- String
+    - **Description**-It contains the input which is a command. The command that will be executed on Windows.
+    
+2. Second parameter:
+    - **Required**
+    - **Type**- String
+    - **Description**-It contains the input which is a command. The command that will be executed on Linux.
+    
+3. Third parameter:
+    - **Required**
+    - **Type**- JSON object
+    - **Description**- JSON object with optional fields
+        * **First attribute**: (Optional) Directory where the command will be executed, if not in current directory (relative to workspace)
+            Example: {"dir": string}
+        * **Second attribute**: (Optional) Synchronous or asynchronous process. Use asynchronous when starting a server. Default is synchronous. 
+            Example: {"asynchronous": boolean}
+        * **Third attribute**: (Optional) Array of arguments 
+            Example: {"args": string[]}
+  
+4. Fourth parameter:
+    - **Required**
+    - **Type**- JSON object
+    - **Description**-Assertion information needed if you start a server to check server availability. Only required when you start a asynchronous server. This parameter is           only needed when the command is an asynchronous command.
 
 #### Commands
 It is needed to pass a command for Windows and also for Linux-based systems because both systems will always be tested.
@@ -182,17 +204,25 @@ interval: The availability of the server is checked in the given interval
 
 #### example
 
-executeCommand("node", "node" ,{"args": ["-v"]})
+* executeCommand("node", "node" ,{"args": ["-v"]})
 Will create a command for executing node -v .
 
-executeCommand("somePollingScript.ps1","bash somePollingScript.sh", {"dir": "data/setup","asynchronous": true, "args": ["--params 5"]})
-Will create a command to execute the script in the directory with the parameter --params 5 and in a new terminal.
+* executeCommand("somePollingScript.ps1","bash somePollingScript.sh", {"dir": "data/setup", "args": ["--params 5"]})
+Will create a command to execute the script in the directory with the parameter --params 5 and in the current command prompt. The command prompt will be blocked until you stop the script.
 
-executeCommand("someServerScript.ps1","bash someServerScript.sh", {"asynchronous": true, "args":["-port 8080"] },{"port":8080 , "startupTime": 20, "path": "some/path/", "interval": 2})
+* executeCommand("someServerScript.ps1","bash someServerScript.sh", {"asynchronous": true, "args":["-port 8080"] },{"port":8080 , "startupTime": 20, "path": "some/path/", "interval": 2})
 Starting a server in a new terminal. You have to specify the port for testing, the other parameters are optional. The startupTime can specify how long the runner will wait for a response from the server process and with interval you can set the frequenzy for the server testing. The path is the subpath from your server that should be reached.
 
 ***
 
+Note: 
+
+1. The command for execution will be generated by Katacoda runner, so user will have to execute this command manually.
+
+2. This command uses '/bin/sh' on Unix and the shell specified in %COMSPEC% on Windows.(Mostly cmd.exe, if you want to execute it on powershell add powershell.exe at the start of the command) 
+
+***
+
 ### installCobiGen <a name="installGobiGen"></a>
 #### parameter
 * No parameters
@@ -456,11 +486,12 @@ In second parameter, you can add 3 attributes.
 - **Third attribute**: It is optional and it is the array of npm arguments. 
 
   Example: {"args": string[]}
+
 #### example
-* npmInstall("jump-the-queue/angular", {"name": "@angular/cli", "global": true, "args": ["--save-dev"]})
+npmInstall("jump-the-queue/angular", {"name": "@angular/cli", "global": true, "args": ["--save-dev"]})
 will run 'npm install -g --save-dev @angular/cli' in the directory 'jump-the-queue/angular'.
 
-* npmInstall("my-thai-star/angular")
+npmInstall("my-thai-star/angular")
 will run 'npm install' in the directory 'my-thai-star/angular'
 
 Note: