Please provide API documentation in comments, or at least provide a reference. about onesky-ruby HOT 5 CLOSED

for upload_file, please reference this:
https://github.com/onesky/api-documentation-platform/blob/master/resources/file.md#upload---upload-a-file

from onesky-ruby.

Resolved by 427a9fe

from onesky-ruby.

hi @rubyluk - thank you but i do not think that is a good solution. Can you make it more clear that "Platform API" links to documentation ? it is very unclear, and in any case, it does not provide a reference from API documentation. onesky-ruby gem is totally useless inside pry and when using its show-doc command, as well for example. It is not good practice to leave any gem 100% undocumented. I recommend you consider something like http://yardoc.org/ to provide accurate and informative documentation, it supports tags, so you could use @see tag to reference that markdown document.

i'm disappointed by the solution. "OneSky"(active link) "Platform API"(active link). these are two different links going to two different places, they are present in README only, and yeah... very poor, i'm sad to say.

from onesky-ruby.

that i even have to explain this, it worries me very much. i can't really believe it in a way.

from onesky-ruby.

the code itself by the way, has so much indirection going on(very bad for code nav), that finding "upload_file" definition was hard work and when i do find it, it's undocumented, and i have to go back to the readme to somehow notice that second link which is not a direct link to the HTTP API docs for upload_file, it requires more jumps to get there. please provide a better solution.

from onesky-ruby.