tweepy: Model documentation missing
Documentation for the different models supplied by tweepy such as Status and User are missing, which makes it hard for me to understand how to use these objects (which are often referred to in the docs)
About this issue
- Original URL
- State: closed
- Created 8 years ago
- Reactions: 27
- Comments: 16 (3 by maintainers)
I’d be willing to take this on.
It is still missing, please add it.
please, add it, still missing
The documentation says to see “ModelsReference” but I can’t find anything with that name in tweepy
Next week I’ll try to reserve some time to make the ModelsReference. I was looking for it right now and didn’t know it was still missing, let’s solve it to help new developers.
Tweepy’s documentation is generally supplemented by the documentation for Twitter’s API. In this case, Tweepy’s models usually mirror that of the API’s, for which the documentation can be found at https://developer.twitter.com/en/docs/twitter-api/v1/data-dictionary/overview. This issue is for tracking including that documentation within Tweepy’s documentation as well.
Agreed, this would be really useful.
Still missing
Were you perusing the readthedocs reference? As it says at the beginning, it is a work in progress. I checked their API reference page and indeed it doesn’t yet have documention for
StatusandUser. You can either wait for someone to make a pull request on the documentation amending this, do it yourself, or make do with looking at the source code for those models here (Status) and here (User).