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

API glossary/index #1036

Closed
joecridge opened this issue Oct 25, 2015 · 3 comments
Closed

API glossary/index #1036

joecridge opened this issue Oct 25, 2015 · 3 comments

Comments

@joecridge
Copy link
Contributor

@joecridge joecridge commented Oct 25, 2015

Feel free to close this if one already exists, but do we have a API cheatsheet like this anywhere, or could we generate one in the same way we generate the online reference?

I feel like it would be useful for developers or users who know what functions do but can't quite remember their name or syntax…

@lmccart

This comment has been minimized.

Copy link
Member

@lmccart lmccart commented Oct 25, 2015

all the functions are listed here: http://p5js.org/reference/
though they don't show the parameters until you click into the page.
if we did add a page like this, it would be best if it were auto-generated and auto-updated when the docs are updated. otherwise I worry it just adds another task to an already really long list of things to maintain.

@joecridge

This comment has been minimized.

Copy link
Contributor Author

@joecridge joecridge commented Oct 25, 2015

Yeah, I was thinking of single resource that could be easily saved for offline use or to generate syntax highlighting rules, etc. If it's something that could be added as an additional task for the documentation parser that would be awesome, but if it's going to be more involved than that then it probably isn't worthwhile.

@lmccart

This comment has been minimized.

Copy link
Member

@lmccart lmccart commented Jan 22, 2016

ah i see. i think this json file contains all the necessary info then, it is what is used to populate the reference: http://p5js.org/reference/data.json

@lmccart lmccart closed this Jan 22, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.