Browse Source

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

master
Craig Oates 6 years ago
parent
commit
b457adb32c
  1. 15
      BrittleFish/ConsoleCommands.fs
  2. 3
      BrittleFishCore/ConsoleCommands.fs

15
BrittleFish/ConsoleCommands.fs

@ -49,30 +49,27 @@
[<Parameters "none">] [<Parameters "none">]
[<Usage "> test 1">] [<Usage "> test 1">]
let ``test 1``() = "Result: Test 1 working" let ``test 1``() = "Result: Test 1 working"
(*This does not work.*)
[<ListCommand>] [<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">] [<Parameters "none">]
[<Usage "> test 2">] [<Usage "> test-2">]
let ``test-2``() = "Result: Test 2 working" let ``test-2``() = "Result: Test 2 working"
(*This only works when you type "test 2" not ideal but better then nothing (*This works.*)
THIS IS DIFFERENT THAN THE CORE VERSION OF THE FRAMEWORK.*)
[<ListCommand>] [<ListCommand>]
[<Description "Displays a message in the console, signfying the command-method is working.">] [<Description "Displays a message in the console, signfying the command-method is working.">]
[<Parameters "none">] [<Parameters "none">]
[<Usage "> test 3">] [<Usage "> test 3">]
let """test 3""" = "Result: Test 3 working" let """test 3""" = "Result: Test 3 working"
(*This is not displayed in the help section, regardless of the attributes. (*This does not work.*)
It still works if you enter the command into the console, though.*)
[<ListCommand>] [<ListCommand>]
[<Description "Displays a message in the console, signfying the command-method is working.">] [<Description "Displays a message in the console, signfying the command-method is working.">]
[<Parameters "none">] [<Parameters "none">]
[<Usage "> test 4">] [<Usage "> test 4">]
let """test-4""" = "Result: Test 4 working" let """test-4""" = "Result: Test 4 working"
(* This only works when you type "test 4" not ideal but better then nothing. (* This does not work.*)
This is not displayed in the help section, regardless of the attributes.
It still works if you enter the command in the console, though.*)

3
BrittleFishCore/ConsoleCommands.fs

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

Loading…
Cancel
Save