Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Functions #39

Open
aciccarello opened this issue Dec 14, 2017 · 0 comments
Open

Document Functions #39

aciccarello opened this issue Dec 14, 2017 · 0 comments

Comments

@aciccarello
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant