python-midi icon indicating copy to clipboard operation
python-midi copied to clipboard

Improve Documentation

Open G3zz opened this issue 7 years ago • 2 comments

I have found this library very useful so far, but on occasion I have been a little frustrated with the lack of documentation. In particular, I'd like to know exactly what is kept in the data field for each type of event, but more generally, I think we should try and expand the documentation to include more information and perhaps go into some detail for the common use-cases, or even document the whole API.

I'm obviously happy to contribute as my knowledge of the source code improves 👍

G3zz avatar Jul 12 '17 09:07 G3zz

I have discovered this library recently and I also can not make sense of what the data field signifies in any of the various events. Are there any resources which can help me understand better?

iakash2604 avatar Mar 01 '18 12:03 iakash2604

By running this program and checking their documentation I figured out what the parameters are for the dump of this library. For instance, about the notes, an on/off event with data=[x, y] and ticks=t indicates that time advances t (t=0 means event happens at the same time as the previous one) and note x is played/released with velocity y

damaru2 avatar Dec 01 '18 12:12 damaru2