samsymons / RedditKit.rb

[Deprecated] A Ruby wrapper for the reddit API
https://redditkit.com/
MIT License
152 stars 26 forks source link

why are the names of options different from the options that reddit wants? #17

Closed jtoy closed 10 years ago

jtoy commented 10 years ago

https://github.com/samsymons/RedditKit.rb/blob/master/lib/redditkit/client/private_messages.rb#L32

reddit wants captcha and iden, but you want captcha_value and captcha_indentifier. It makes the library very painful to use.

jtoy commented 10 years ago

this happens all over the library, this is just one example

samsymons commented 10 years ago

That's because reddit's parameters often have unclear names – I decided I'd rather rename them to something which is obvious, and hide the lack of clarity from the user. I prefer having the option names themselves be descriptive and self-documenting, to save having to go and check reddit's API documentation for what they actually mean.