Automatically fill in method docstrings (and even new methods/parameters?) from the Twitter API Docs #394

Open
Aaron1011 opened this Issue Feb 22, 2014 · 1 comment

Comments

Projects
None yet
2 participants
Owner

Aaron1011 commented Feb 22, 2014

I was inspired by @jackdied's PR: #259, which scrapes the docs, looking for mismatches with allowed_parameters (I don't think it works with the current docs/code).

This would allow Tweepy to be updated quickly whenever Twitter changes their API. It would also save us the work of documenting every single API method manually.

The downside is that dowloading all of the docs and scraping them can be slow, and the documentation HTML isn't versioned (obviously 😄), so the script could break suddenly.

@joshthecoder: What are you thoughts?

Owner

joshthecoder commented Feb 22, 2014

The tool might be useful for the current design of Tweepy's binding system, but yes it could be brittle. I have been thinking about just removing allowed_parameters all together. The only issue is for positional arguments. Ex: api.update_status(text) needs to map the 1st argument to 'text'.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment