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.

Sign up for GitHub

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

Jump to bottom

add variable types to documentation #91

Open
frabarz opened this issue Jul 18, 2018 · 0 comments
Open

add variable types to documentation #91

frabarz opened this issue Jul 18, 2018 · 0 comments
Labels
chore

Comments

@frabarz
Copy link

frabarz commented Jul 18, 2018

Current Behavior

Right now, the documentation shows how many variables a function accept, and if they are required or not.

Expected Behavior

The variables in the documentation website should include the types expected by the functions. Additionally, I suggest to change the format for optional variables from [value] to value?.
@davelandry davelandry changed the title Add types to variables on the documentation website add variable types to documentation Jul 18, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
chore
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@davelandry @frabarz