Some documentation for calling conventions would be nice

Burgestrand / spotify

Low-level Ruby bindings for libspotify, the official Spotify C API

https://rubygems.org/gems/spotify

Other

146 stars 17 forks source link

Some documentation for calling conventions would be nice #21

Closed ghost closed 10 years ago

ghost commented 11 years ago

Would like to describe:

[x] libspotify best practices (I don’t know many, but linking to the FAQ etc is good)
[x] where to get documentation
[x] how to translate libspotify documentation into spotify ruby gem documentation
[x] mapping for each libspotify type to spotify ruby type

// @Burgestrand

ashmckenzie commented 11 years ago

+1 :)

Burgestrand commented 10 years ago

Frankly, I don’t think the last commit did a good job of this. I have been adding documentation to the actual API methods documented on Spotify::API. Adding some more at the moment, but I have a large chunk of it on another computer, where I forgot to push. It’ll come up in a few days.

Burgestrand commented 10 years ago

Pushed a big chunk of documentation. More coming.

Burgestrand commented 10 years ago

This issue can never truly be closed because of it being so open in it's definition, but it's now way better than it was. Closing it for now.