Browse Source

Began adding corrected notes about F# command-methods calls.

master
Craig Oates 4 years ago
parent
commit
b457adb32c
2 changed files with 8 additions and 10 deletions
  1. +6
    -9
      BrittleFish/ConsoleCommands.fs
  2. +2
    -1
      BrittleFishCore/ConsoleCommands.fs

+ 6
- 9
BrittleFish/ConsoleCommands.fs View File

@ -49,30 +49,27 @@
[<Parameters "none">]
[<Usage "> test 1">]
let ``test 1``() = "Result: Test 1 working"
(*This does not work.*)
[<ListCommand>]
[<Description "Displays a message in the console, signfying the command-method is working. The command uses F#'s double back-tick notation -- hence the command name and usage example not matching up.">]
[<Description "Displays a message in the console, signfying the command-method is working. The command uses F#'s double back-tick notation.">]
[<Parameters "none">]
[<Usage "> test 2">]
[<Usage "> test-2">]
let ``test-2``() = "Result: Test 2 working"
(*This only works when you type "test 2" not ideal but better then nothing
THIS IS DIFFERENT THAN THE CORE VERSION OF THE FRAMEWORK.*)
(*This works.*)
[<ListCommand>]
[<Description "Displays a message in the console, signfying the command-method is working.">]
[<Parameters "none">]
[<Usage "> test 3">]
let """test 3""" = "Result: Test 3 working"
(*This is not displayed in the help section, regardless of the attributes.
It still works if you enter the command into the console, though.*)
(*This does not work.*)
[<ListCommand>]
[<Description "Displays a message in the console, signfying the command-method is working.">]
[<Parameters "none">]
[<Usage "> test 4">]
let """test-4""" = "Result: Test 4 working"
(* This only works when you type "test 4" not ideal but better then nothing.
This is not displayed in the help section, regardless of the attributes.
It still works if you enter the command in the console, though.*)
(* This does not work.*)

+ 2
- 1
BrittleFishCore/ConsoleCommands.fs View File

@ -5,12 +5,13 @@
open Console.Waterworks.Core
open Console.Waterworks.Core.Attributes
open FunkyFishCore // This is where the "LibraryTest" functions are -- in BFLibCore
(*
[<ListCommand>]
[<Description "Display a message to the console signifying the program is running as intended.">]
[<Parameters "none">]
[<Usage "> test">]
let test() = "The console is working"
*)
[<ListCommand>]
[<Description "Closes the program.">]


Loading…
Cancel
Save