Skip to content

Commit a578be4

Browse files
authored
Implemented review comments
1 parent acec61f commit a578be4

1 file changed

Lines changed: 19 additions & 12 deletions

File tree

documentation/Functions.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -322,26 +322,33 @@ downloadFile("https://bit.ly/2BCkFa9", "file", "downloads")
322322
***
323323

324324
### buildNg <a name="buildNg"></a>
325-
This function is used to build angular project.
325+
This function is used to build Angular project.
326326

327327
#### parameter
328-
You need two parameter for this function.
328+
This function consist of two parameter.
329329

330-
Example: buildNg(1st-parameter, 2nd-parameter)
330+
1. First parameter:
331+
- **Required**
332+
- **type**- String
333+
- **Description**-It is the path to the Angular project, relative to workspace.
331334

332-
1st-parameter: It is the path to the angular project, relative to workspace. It is of type String.
333-
334-
2nd-parameter: It is an optional parameter. It is the Custom output directory. it is of type String.
335+
2. Second parameter:
336+
- **optional**
337+
- **type**- String
338+
- **Description**- It is the custom output directory.
335339
#### example
336-
1. buildNg("exampleAngularProject")
337-
Will build the angular project to default output directory defined in angular.json outputPath key, normally set to dist/.
340+
* buildNg("exampleAngularProject")
341+
Will build the Angular project to default output directory defined in angular.json outputPath key, normally set to dist/.
338342

339-
2. buildNg("exampleAngularProject", "testOutput")
340-
Will build the angular project to output directory testOutput.
343+
* buildNg("exampleAngularProject", "testOutput")
344+
Will build the Angular project to output directory testOutput.
341345

342346
Note:
343-
1. To use only one parameter, you should have angular installed and the folder should exist.
344-
2. No background script will run. Katacoda user will have to manually execute this function.
347+
1. To use only one parameter, you should have Angular CLI installed and the folder should exist. This can be done by using the devonfw-ide or by installing it manually with the npmInstall function.
348+
349+
2. The command for execution will be generated by katacoda runner, so user will have to execute this command manually.
350+
351+
3. No background script will run.
345352

346353
***
347354

0 commit comments

Comments
 (0)