Package com.github.basking2.sdsai.itrex.functions

Interface HelpfulFunction

All Known Implementing Classes:
CurryFunction, HelpFunction, LetFunction, ListFlattenFunction
public interface HelpfulFunction
A function that has help text.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    functionHelp(String name, boolean verbose)
    Returns help text for how this function should be used.

  • Method Details

    • functionHelp

      String functionHelp(String name, boolean verbose)
      Returns help text for how this function should be used.
      Parameters:
      name - The name the function is called. Functions may have aliases.
      verbose - Should this help be verbose or simplistic.
      Returns:
      A string that describes how to use a function. This may be a Markdown formatted string.