master
Craig Oates 4 years ago
parent
commit
24b03817b1
  1. 14
      Command-Methods-Overview.md

14
Command-Methods-Overview.md

@ -1,6 +1,6 @@
Without going into too much detail, a "command-method" is a function within the `ConsoleCommands` module. The name "command-method" is inaccurate here but I have kept it to remain consistent with Console.Waterworks (C.W). If you would like to know more about command-methods, I recommend you read the following wiki entry:
- [Console.Waterworks Wiki -- Writing Command-Methods](https://git.abbether.net/craig.oates/Console.Waterworks/wikis/Writing-Command-Methods)
- [Console.Waterworks Wiki -- Writing Command-Methods](https://git.abbether.net/craig.oates/Console.Waterworks/wiki/Writing-Command-Methods)
For command-methods to work properly, there are several things they need. Which are:
@ -49,8 +49,8 @@ To help explain what the above code, please consider the image below.
It is not essential to include the help attributes but they do provide help for the end-user and future developers. For more information about the help attributes, please use the following links:
- [Console.Waterworks Wiki -- Using the "Help Attributes"](https://git.abbether.net/craig.oates/Console.Waterworks/wikis/Using-the-%22Help-Attributes%22)
- [Brittle Fish Wiki](https://git.abbether.net/craig.oates/Brittle-Fish/wikis/home)
- [Console.Waterworks Wiki -- Using the "Help Attributes"](https://git.abbether.net/craig.oates/Console.Waterworks/wiki/Using-the-Help-Attributes)
- [Brittle Fish Wiki](https://git.abbether.net/craig.oates/Brittle-Fish/wiki)
The name of the command-method is what the end-user must enter into the console. If the command-method requires input arguments, the end-user must provide them, as well. For example, please consider the following image:
@ -58,7 +58,7 @@ The name of the command-method is what the end-user must enter into the console.
If all has gone well, you should be able to work your way through "ConsoleCommands.fs" and understand it. With that said, you will come across functions which appear to have no explanation for why the exist. If you dig around a little bit, you will notice these functions are either situated in "Validation.fs" or the .Net Standard library (I.E. "SmoulderingBeachBall"). Use the following links for more information:
- [ConsoleCommands.fs](https://git.abbether.net/craig.oates/Smouldering-Beach-Ball/blob/master/SmoulderingBeachBallCLI/ConsoleCommands.fs)
- [Validation.fs](https://git.abbether.net/craig.oates/Smouldering-Beach-Ball/blob/master/SmoulderingBeachBallCLI/Validation.fs)
- [Services.fs (SmoulderingBeachBall)](https://git.abbether.net/craig.oates/Smouldering-Beach-Ball/blob/master/SmoulderingBeachBall/Services.fs)
- [Console(Commands) A.P.I. (As C.L.I. section)](https://git.abbether.net/craig.oates/Smouldering-Beach-Ball/wikis/Console-API)
- [ConsoleCommands.fs](https://git.abbether.net/craig.oates/Smouldering-Beach-Ball/src/branch/master/SmoulderingBeachBallCLI/ConsoleCommands.fs)
- [Validation.fs](https://git.abbether.net/craig.oates/Smouldering-Beach-Ball/src/branch/master/SmoulderingBeachBallCLI/Validation.fs)
- [Services.fs (SmoulderingBeachBall)](https://git.abbether.net/craig.oates/Smouldering-Beach-Ball/src/branch/master/SmoulderingBeachBall/Services.fs)
- [Console(Commands) A.P.I. (As C.L.I. section)](https://git.abbether.net/craig.oates/Smouldering-Beach-Ball/wiki/Console-API)
Loading…
Cancel
Save