polyphonic_track icon indicating copy to clipboard operation
polyphonic_track copied to clipboard

Better Documentation / Annotation Demanded

Open Feliconut opened this issue 4 years ago • 1 comments

I would really appreciate it if you'd like to spend a little amount of time adding docstrings for the methods including their input and output format, and explicitly define the data exchanging format between modules. Even better if you can draw an entity-relationship diagram. In this way, I can understand your code better and build upon it to make it production-ready.

Also, I'd like to rewrite your PureData module in Python so everything becomes neat and simple to implement. I can do this effectively only if explicit, detailed data exchange format is provided.

You are a genius! Even more genius if you'd like to add more documentation! May God bless you!

Feliconut avatar May 31 '20 18:05 Feliconut

hi i will get to it eventually. been very busy with work and other projects

jaylmiller avatar Dec 23 '20 22:12 jaylmiller