From 1b08e20a2a1298c5a9f9668ab3d9a9c634085a65 Mon Sep 17 00:00:00 2001 From: Harmon Date: Mon, 24 May 2021 09:06:13 -0500 Subject: [PATCH] Update and improve documentation for API.subscribe_list --- tweepy/api.py | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/tweepy/api.py b/tweepy/api.py index 9a92e17..998d49d 100644 --- a/tweepy/api.py +++ b/tweepy/api.py @@ -1918,14 +1918,24 @@ class API: Subscribes the authenticated user to the specified list. - :param owner_screen_name: |owner_screen_name| - :param owner_id: |owner_id| - :param list_id: |list_id| - :param slug: |slug| + Parameters + ---------- + owner_screen_name + |owner_screen_name| + owner_id + |owner_id| + list_id + |list_id| + slug + |slug| - :rtype: :class:`List` object + Returns + ------- + :class:`~tweepy.models.List` - :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-subscribers-create + References + ---------- + https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-subscribers-create """ return self.request( 'POST', 'lists/subscribers/create', endpoint_parameters=( -- 2.25.1