covalent-highlight-nightly icon indicating copy to clipboard operation
covalent-highlight-nightly copied to clipboard

Document Functions

Open aciccarello opened this issue 7 years ago • 0 comments

Documentation improvement

Currently the only documentation of functions is on the CRUD page

Functions

Function variables are denoted with parenthesis following the function name. These are set functions that are supplied with Covalent Data. They can either be used independent of datum variables, or as inputs. For instance, {{uuid()}} will return a UUID v4 compliant unique ID, and {{toLower(.firstname)}} will return a random firstname datum variable that has been lower cased.

Nowhere does it actually list what functions are available. The ones I've found are in functions.go

What is the expected behavior?

The documentation should clearly list what functions are implemented and their interfaces.

  • randomNumber(maximumNumber)
  • UUID()
  • toLower(text)
  • toUpper(text)

What is the motivation / use case for changing the behavior?

Completeness of documentation

Other information

I'd be willing to submit a PR for this

aciccarello avatar Dec 14 '17 18:12 aciccarello