search

ostrosco / comms-rs

A library for building DSP communication pipelines.
MIT License
13 stars 1 forks source link

Sparse Documentation #68

Open garbagetrash opened 5 years ago

garbagetrash commented 5 years ago

The documentation seems pretty sparse. Probably should make a concerted effort to comb through it and add where you can. Since 'improve documentation' is a pretty vague goal we should discuss some kind of boxed boundaries for the scope of this, or maybe just vote on whether it's good enough or something.

Anyways, I feel like we can do a bit better here.

ostrosco commented 5 years ago

I think one of the big things we need is a straight up tutorial for our two most common use cases: users wanting to hook up existing nodes into a graph and users who want to write their own nodes using the existing infrastructure. I'll figure out the best way to do that.

garbagetrash commented 5 years ago

Sounds good to me!

I'll work on filling out some of the documentation for the existing modules. I just finished up with the util module, and spammed a bunch of new issues for the remaining modules. This issue can be for your part. I'll assign myself to the newly spammed issues as I work them.