search

ostrosco / comms-rs

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

Improve generated documentation #56

Closed ostrosco closed 5 years ago

ostrosco commented 5 years ago

Currently the generated documentation from cargo doc is either incomplete or unreadable. We'd like to improve the documentation to make use of the library easier.

ostrosco commented 5 years ago

Adding @rfdoell since they expressed interest in this problem previously.

ostrosco commented 5 years ago

Cleaned up the docs as part of #57. More work to be done, but the initial problem of not being able to read the docs at all has been addressed.