add images to Command-Methods Overview.

master
Craig Oates 5 years ago
parent
commit
ec4820199e
  1. 6
      Command-Methods-Overview.md
  2. BIN
      attachments/command-method-binding-example.png
  3. BIN
      attachments/deathsocketcli-run-time-commands-screenshot.png

6
Command-Methods-Overview.md

@ -14,7 +14,7 @@ Please note, this list is not complete. But, the extra stuff is more to do with
- [Brittle Fish Repository](https://gitlab.com/craig.oates/Brittle-Fish)
Having got the above out of the way, here is a couple of command-method example to help you get a feel for how they look. (Each on includes the "help" attributes.)
Having got the above out of the way, here is a couple of command-method examples to help you get a feel for how they look. (Each on includes the "help" attributes.)
```f#
[<ListCommand>]
@ -45,7 +45,7 @@ let ``list-colours`` () =
```
To help explain what the above code does, please consider the following image;
IMAGE OF COMMAND-METHOD BREAKDOWN
![command-method binding example](attachments/command-method-binding-example.png)
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;
@ -54,7 +54,7 @@ It is not essential to include the help attributes but they do provide help for
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;
SCREENSHOT OF C-M MATCHING CONSOLE INPUT
![deathsocketcli run-time commands screenshot](attachments/deathsocketcli-run-time-commands-screenshot.png)
If all has gone well, you should be able to work your way through "Commands.fs" and understand it. With that said, you will come across functions which appear to have no explanation for where/why they 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. "DeathSocket"). Use the following links for more information;

BIN
attachments/command-method-binding-example.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 126 KiB

BIN
attachments/deathsocketcli-run-time-commands-screenshot.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 178 KiB

Loading…
Cancel
Save