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

Add documentation for the @js functions and friends #167

Merged
merged 2 commits into from
Oct 12, 2018

Conversation

NHDaly
Copy link
Collaborator

@NHDaly NHDaly commented Oct 11, 2018

Part of #160.

@NHDaly
Copy link
Collaborator Author

NHDaly commented Oct 11, 2018

I would actually really appreciate someone's review on this one before I merge it! :)

Thanks!

@pfitzseb
Copy link
Member

I feel like "...converted to javascript..." warrants some more explanation, but I'm not sure if those docstrings are the best place for that. LGTM otherwise.

@NHDaly
Copy link
Collaborator Author

NHDaly commented Oct 12, 2018

Hmm agreed. Would it be too much to add something like this small paragraph to both of those?:

`expr` will be parsed as julia code, and then converted directly to the
equivalent javascript. Language keywords that don't exist in julia can be
represented with their macro equivalents, `@var`, `@new`, etc.

@NHDaly
Copy link
Collaborator Author

NHDaly commented Oct 12, 2018

Okay cool! :) I've just added that, and i'll merge it now. We can always change the docstring later! :)

@NHDaly NHDaly merged commit 3c54b47 into JuliaGizmos:master Oct 12, 2018
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

Successfully merging this pull request may close these issues.

2 participants