Skip to content

Commit ae62e3e

Browse files
committed
Updated documentation.
1 parent 487119d commit ae62e3e

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

Docs/Design_command.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Using argument and suggestion your design attribute could look like this.
6969
suggestions: "xml|json",
7070
example: "//Convert to json format|convert json --path \"c:\\temp\\test.yaml\"|//Convert to xml format|convert xml --path \"c:\\temp\\test.yaml\"")]
7171
```
72-
The user can hus the tab to cycle trough the different formats.
72+
The user can use the tab to cycle trough the different formats.
7373

7474
The whole code example below:
7575
```
@@ -94,16 +94,18 @@ public class ConvertCommand : CommandBase<PowerCommandsConfiguration>
9494
}
9595
}
9696
```
97+
### **Please Note** that the name of the arguments in the design attribute is not important in code, it is usefull thou when help about the command is displayed. Suggestions is what it sounds like only suggestions to guide the user to the right input.
9798

9899
## Must I use the PowerCommandDesign attribute on every command I create?
99-
No that is not mandatory but it is recommended, note that when you declare the [Options](Options.md), they will be available for code completion, wich means that when the consumer types - and hit the tab button the user will can se what options there are that could be used, with a simple ! character you tell that the argument, quote, option or secret is required and then the Core runtime will validate that automatically for you. That is really nice, you could read more about design of good Command Line Inter fade design here:
100+
No that is not mandatory but it is recommended, note that when you declare the [Options](Options.md), they will be available for code completion, wich means that when the consumer types - and hit the tab button the user will can se what options there are that could be used, with a simple ! character you tell that the argument, quote, option or secret is required and then the Core runtime will validate that automatically for you.
101+
102+
Read more about CLI design here: [10 design principles for delightful CLIs](https://blog.developer.atlassian.com/10-design-principles-for-delightful-clis/)
100103

101104
Next step is to understand the [Power Commands Design attribute](PowerCommandDesignAttribute.md)
102105

103-
[10 design principles for delightful CLIs](https://blog.developer.atlassian.com/10-design-principles-for-delightful-clis/)
104106

105-
Read more about:
106107

108+
Read more about:
107109

108110
[Input](Input.md)
109111

0 commit comments

Comments
 (0)