Skip to content

Commit 0c7b7a9

Browse files
authored
Implemented review comments
1 parent 40ec0f0 commit 0c7b7a9

1 file changed

Lines changed: 29 additions & 29 deletions

File tree

documentation/Functions.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,10 @@ The following functions are already implemented:
2525

2626
* [File And Directory Functions](#fileSpecific)
2727
1. [changeFile](#changeFile)
28-
2. [createFile](#createFile)
29-
3. [downloadFile](#downloadFile)
30-
4. [openFile](#openFile)
28+
2. [createFile](#createFile)
29+
3. [createFolder](#createFolder)
30+
4. [downloadFile](#downloadFile)
31+
5. [openFile](#openFile)
3132

3233
* [Katacoda Environment Functions](#katacodaSpecific)
3334
1. [displayContent](#displayContent)
@@ -37,10 +38,9 @@ The following functions are already implemented:
3738

3839
* [Workspace Functions](#workspaceSpecific)
3940
1. [changeWorkspace](#changeWorkspace)
40-
2. [createFolder](#createFolder)
41-
3. [restoreWorkspace](#restoreWorkspace)
41+
2. [restoreWorkspace](#restoreWorkspace)
4242

43-
* [Other Function](#otherFunctions)
43+
* [Custom Function](#customFunctions)
4444
1. [addSetupScript](#addSetupScript)
4545
2. [executeCommand](#executeCommand)
4646

@@ -450,7 +450,26 @@ This function will work without a devonfw-ide installation.
450450

451451
***
452452

453-
### iii. downloadFile <a name="downloadFile"></a>
453+
### iii. createFolder <a name="createFolder"></a>
454+
This function is used to create a new folder.
455+
#### Parameter:
456+
This function consist of one parameter.
457+
458+
1. First parameter:
459+
- **Required**
460+
- **Type**- String
461+
- **Description**- Path of the folder to be created (relative to working directory). Subdirectories are also created.
462+
463+
#### Example:
464+
* createFolder("directoryPath/subDirectory")
465+
466+
##### Note:
467+
1. The command for execution will be generated by Katacoda runner, so user will have to execute this command manually.
468+
2. It can be used before any command which needs to be executed in such folder which doesn't exist.
469+
470+
***
471+
472+
### iv. downloadFile <a name="downloadFile"></a>
454473
This function is used to download a file from an external URL.
455474
#### Parameter:
456475
This function consist of 3 parameters.
@@ -474,7 +493,7 @@ The command for execution will be generated by Katacoda runner, so user will hav
474493

475494
***
476495

477-
### iv. openFile <a name="openFile"></a>
496+
### v. openFile <a name="openFile"></a>
478497
This function is used to open a particular file.
479498

480499
#### Parameter:
@@ -593,26 +612,7 @@ Learn more about the workspace directory and working directory on [Structure](ht
593612

594613
***
595614

596-
### ii. createFolder <a name="createFolder"></a>
597-
This function is used to create a new folder.
598-
#### Parameter:
599-
This function consist of one parameter.
600-
601-
1. First parameter:
602-
- **Required**
603-
- **Type**- String
604-
- **Description**- Path of the folder to be created (relative to working directory). Subdirectories are also created.
605-
606-
#### Example:
607-
* createFolder("directoryPath/subDirectory")
608-
609-
##### Note:
610-
1. The command for execution will be generated by Katacoda runner, so user will have to execute this command manually.
611-
2. It can be used before any command which needs to be executed in such folder which doesn't exist.
612-
613-
***
614-
615-
### iii. restoreWorkspace <a name="restoreWorkspace"></a>
615+
### ii. restoreWorkspace <a name="restoreWorkspace"></a>
616616
This function is used to clone an existing GitHub repository to the working directory of the tutorial. It can be used to continue the tutorial with the state of a previous tutorial located in the repository to be cloned.
617617
#### Parameter:
618618
This function only consist of one parameter.
@@ -680,7 +680,7 @@ Learn more about the workspace directory and working directory on [Structure](ht
680680

681681
***
682682

683-
## Other Functions <a name="otherFunctions"></a>
683+
## Custom Functions <a name="customFunctions"></a>
684684

685685
### i. addSetupScript <a name="addSetupScript"></a>
686686
This function is used to add a script which is executed on startup of the tutorial.

0 commit comments

Comments
 (0)