search

duarteguilherme / congressbr

An R package that returns tidy data from the APIs of the Brazilian Federal Senate and Chamber of Deputies.
https://robertmyles.github.io/congressbr/
Other
43 stars 6 forks source link

improve code documentation #2

Closed danilofreire closed 7 years ago

danilofreire commented 7 years ago

Document what is returned from functions (columns and values etc.)

RobertMyles commented 7 years ago

I'm also not sure what some of the variables represent in the results from the Senate. In sen_senator, for example, there is a leadership list, with variables that, as of yet, have no documentation on the API.

danilofreire commented 7 years ago

Should we write the Senate and ask for more info on the API?

RobertMyles commented 7 years ago

Maybe! Good idea.

danilofreire commented 7 years ago

Just tell me what you want to know, if more than that, and I'll write a formal email to the Senate. I'm not sure they'll reply because, well, it's the Brazilian bureaucracy. But we might give it a shot!

On 8 Mar 2017 19:56, "Robert Myles McDonnell" notifications@github.com wrote:

Maybe! Good idea.

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/RobertMyles/congressbr/issues/2#issuecomment-285150619, or mute the thread https://github.com/notifications/unsubscribe-auth/AETRRkuMeBO_Psxf9Of-QM7YUq0dzR57ks5rjwfogaJpZM4MTeMv .

RobertMyles commented 7 years ago

Great. I'll compile a list of the things I'm not sure of.

danilofreire commented 7 years ago

Kewl, maybe it's better if we write a single email. What do you think?

On 8 Mar 2017 20:02, "Robert Myles McDonnell" notifications@github.com wrote:

Great. I'll compile a list of the things I'm not sure of.

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/RobertMyles/congressbr/issues/2#issuecomment-285152401, or mute the thread https://github.com/notifications/unsubscribe-auth/AETRRo9_e0G7D8c4scIjdQvdyqmYR5MYks5rjwlogaJpZM4MTeMv .

RobertMyles commented 7 years ago

Yeah, I think that'd probably be better. Or we could bombard them with 8 million...

RobertMyles commented 7 years ago

3 and #12 can be closed with this, it's all part of the same thing.

danilofreire commented 7 years ago

We can close it with #18.