Consistent pagination interface

[hadley]

Cursors

Add next_cursor attribute to outptut (of single inputs). Should pass cursor, retryratelimitandverbosearguments on toTWIT_paginate_cursor()`.

• direct_messages()
• get_followers()
• get_friends()
• lists_members()
• lists_memberships()
• lists_subscribers()
• lists_subscriptions()

max_id

Add max_id attribute to outptut (of single inputs). Should pass since_id, max_id, retryratelimit and verbose on TWIT_paginate_max_id().

• get_favorites()
• get_my_timeline()
• get_timeline()
• get_mentions()
• lists_statuses()
• search_tweets()

Other

• search_users() — uses page paramter
• lookup_users() — TWIT_paginate_chunked()
• lookup_tweets() — TWIT_paginate_chunked()

[hadley]

Consider sleep_on_rate_limit instead of retryratelimit. Would need to deprecate functions already using retryratelimit.

[hadley]

@llrs do you have any thoughts on argument name? I think sleep_on_rate_limit is slightly easier to read and a more accurate description of what it does, but I don't feel that strongly about it. (But I do only want to make the change once, since it's a bunch of functions that need this as an argument.)

[hadley]

Common documentation in progress in #554

[llrs]

I think it might be slightly easier to understand wait_on_rate_limit, but it is still long. (wait_on_limit?)

[hadley]

Cursor plan:

• Add rtweet_cursor attribute to result of TWIT_paginate_cursor
• Ensure parsing preserves/restores the attribute
• Re-work next_cursor() following max_id()/since_id()
• Ensure all functions have necessary arguments

[hadley]

I'm going to leave my_friendships() and lookup_friendships() as is as there doesn't appear to be any indication that they're actually used anywhere (e.g. https://github.com/search?l=R&q=my_friendships&type=Code).

[hadley]

I'm going to close now; search_users() uses its own unique pagination style so while we certainly could make consistent with everything else, I don't think it's particularly high priority.