You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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! :)
The text was updated successfully, but these errors were encountered:
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:
@js
,@js_
, message handling)Window()
,body!
,content!
,load!
)docs
folder and documentation site viaDocumenter.jl
Happy October! :)
The text was updated successfully, but these errors were encountered: