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 All The Things!! #160

Open
1 of 4 tasks
NHDaly opened this issue Oct 6, 2018 · 2 comments
Open
1 of 4 tasks

Document All The Things!! #160

NHDaly opened this issue Oct 6, 2018 · 2 comments

Comments

@NHDaly
Copy link
Collaborator

NHDaly commented Oct 6, 2018

documentallthethings

We're doing it! Let's do it! It's happening!

It's #hacktoberfest this month, and what better time can there be to document all the things! If you are a user of Blink, and want to help, please do stop by and send a PR adding a docstring to a function you use and love!

We've had several Issues along these lines asking for documentation, so I'm going to start this tracking issue to cover documentation. For starters here is a small list of some things that should happen:

  • Docstrings, docstrings, docstrings: Add simple docstrings to all exported names, especially tricky ones (@js, @js_, message handling)
  • Add examples to the docstrings for the most commonly used functions (Window(), body!, content!, load!)
  • Create a docs folder and documentation site via Documenter.jl
    • Add some simple guides for things like communication b/w Julia and JS, uploading a Plot, loading javascript libraries.

Happy October! :)

@NHDaly
Copy link
Collaborator Author

NHDaly commented Oct 6, 2018

This will address #159 and #57

@NHDaly
Copy link
Collaborator Author

NHDaly commented Oct 6, 2018

Okay, I've done one so far! XD

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

No branches or pull requests

2 participants