docs reference private method?
Closed this issue · 3 comments
I might be reading this wrong, but client.rb marks get_account_id
as "internal" but it's referenced in the README. I wouldn't care very much except when I set up my config and try to do what I think is the simplest example from the README, I got nothing:
> client.get_account_id
=> nil
> client.account_id
=> "611155" # this isn't my actual ID but it's correct in my console
Maybe better to replace that example with one that hits the API? client.get_login_information
worked great as a smoke test for me, it was nice to see the wrapper return an HTTP response that contained my info.
(I can submit a PR for the readme, just didn't know if I was missing something)
Hey @arches,
I'm not sure why I even have that in the examples section, it's not very useful I don't think... the rake task to get setup is the only thing that references that method. Users don't ever have to call it directly, so I'm not sure why I put it in the readme. I think the code has it properly marked as internal though.
Perhaps we should just remove it from the readme and add that other call to client.get_login_information
as you suggest. If you want to submit that pull request I'll happily merge it.
Thanks!