Update docstring and organise

Update docstring and organise deprecated methods

Author: chillymosh

twitchio/user.py

@@ -397,29 +397,6 @@ async def fetch_bans(self, token: str, userids: List[Union[str, int]] = None) ->
         data = await self._http.get_channel_bans(token, str(self.id), user_ids=userids)
         return [UserBan(self._http, d) for d in data]
 
-    async def fetch_ban_events(self, token: str, userids: List[int] = None):
-        """|coro|
-
-        This has been deprecated and will be removed in a future release.
-
-        Fetches ban/unban events from the User's channel.
-
-        Parameters
-        -----------
-        token: :class:`str`
-            The oauth token with the ``moderation:read`` scope.
-        userids: List[:class:`int`]
-            An optional list of users to fetch ban/unban events for
-
-        Returns
-        --------
-        List[:class:`twitchio.BanEvent`]
-        """
-        from .models import BanEvent
-
-        data = await self._http.get_channel_ban_unban_events(token, str(self.id), userids)
-        return [BanEvent(self._http, x, self) for x in data]
-
     async def fetch_moderators(self, token: str, userids: List[int] = None):
         """|coro|
 
@@ -496,57 +473,11 @@ async def fetch_stream_key(self, token: str):
         data = await self._http.get_stream_key(token, str(self.id))
         return data
 
-    async def fetch_following(self, token: Optional[str] = None) -> List["FollowEvent"]:
-        """|coro|
-
-        Fetches a list of users that this user is following.
-
-        .. warning::
-
-            The endpoint this method uses has been deprecated by Twitch and is no longer available.
-
-        Parameters
-        -----------
-        token: Optional[:class:`str`]
-            An oauth token to use instead of the bots token
-
-        Returns
-        --------
-        List[:class:`twitchio.FollowEvent`]
-        """
-        from .models import FollowEvent
-
-        data = await self._http.get_user_follows(token=token, from_id=str(self.id))
-        return [FollowEvent(self._http, d, from_=self) for d in data]
-
-    async def fetch_followers(self, token: Optional[str] = None):
-        """|coro|
-
-        Fetches a list of users that are following this user.
-
-        .. warning::
-
-            The endpoint this method uses has been deprecated by Twitch and is no longer available.
-
-        Parameters
-        -----------
-        token: Optional[:class:`str`]
-            An oauth token to use instead of the bots token
-
-        Returns
-        --------
-        List[:class:`twitchio.FollowEvent`]
-        """
-        from .models import FollowEvent
-
-        data = await self._http.get_user_follows(token=token, to_id=str(self.id))
-        return [FollowEvent(self._http, d, to=self) for d in data]
-
     async def fetch_channel_followers(self, token: str, user_id: Optional[int] = None) -> List[ChannelFollowerEvent]:
         """|coro|
 
         Fetches a list of users that are following this broadcaster.
-        Requires a user access token that includes the moderator:read:followers scope.
+        Requires a user access token that includes the ``moderator:read:followers`` scope.
         The ID in the broadcaster_id query parameter must match the user ID in the access token or the user must be a moderator for the specified broadcaster.
 
         Parameters
@@ -578,7 +509,7 @@ async def fetch_channel_following(
         Parameters
         -----------
         token: :class:`str`
-            User access token that includes the moderator:read:followers scope for the channel.
+            User access token that includes the ``moderator:read:follows`` scope for the channel.
         broadcaster_id: Optional[:class:`int`]
             Use this parameter to see whether the user follows this broadcaster.
 
@@ -592,32 +523,6 @@ async def fetch_channel_following(
         data = await self._http.get_channel_followed(token=token, user_id=str(self.id), broadcaster_id=broadcaster_id)
         return [ChannelFollowingEvent(self._http, d) for d in data]
 
-    async def fetch_follow(self, to_user: "PartialUser", token: Optional[str] = None):
-        """|coro|
-
-        Check if a user follows another user or when they followed a user.
-
-        .. warning::
-
-            The endpoint this method uses has been deprecated by Twitch and is no longer available.
-
-        Parameters
-        -----------
-        to_user: :class:`PartialUser`
-        token: Optional[:class:`str`]
-            An oauth token to use instead of the bots token
-
-        Returns
-        --------
-        :class:`twitchio.FollowEvent`
-        """
-        if not isinstance(to_user, PartialUser):
-            raise TypeError(f"to_user must be a PartialUser not {type(to_user)}")
-        from .models import FollowEvent
-
-        data = await self._http.get_user_follows(token=token, from_id=str(self.id), to_id=str(to_user.id))
-        return FollowEvent(self._http, data[0]) if data else None
-
     async def fetch_channel_follower_count(self, token: Optional[str] = None) -> int:
         """|coro|
 
@@ -626,7 +531,7 @@ async def fetch_channel_follower_count(self, token: Optional[str] = None) -> int
         Parameters
         -----------
         token: Optional[:class:`str`]
-            An oauth token to use instead of the bots token
+            An oauth token to use instead of the bots token.
 
         Returns
         --------
@@ -644,7 +549,7 @@ async def fetch_channel_following_count(self, token: str) -> int:
         Parameters
         -----------
         token: :class:`str`
-            An oauth token to use instead of the bots token
+            Requires a user access token that includes the ``user:read:follows`` scope.
 
         Returns
         --------
@@ -654,49 +559,6 @@ async def fetch_channel_following_count(self, token: str) -> int:
         data = await self._http.get_channel_followed_count(token=token, user_id=str(self.id))
         return data["total"]
 
-    async def fetch_follower_count(self, token: Optional[str] = None) -> int:
-        """|coro|
-
-        Fetches the total number of users that are following this user.
-
-        .. warning::
-
-            The endpoint this method uses has been deprecated by Twitch and is no longer available.
-
-        Parameters
-        -----------
-        token: Optional[:class:`str`]
-            An oauth token to use instead of the bots token
-
-        Returns
-        --------
-        :class:`int`
-        """
-
-        data = await self._http.get_follow_count(token=token, to_id=str(self.id))
-        return data["total"]
-
-    async def fetch_following_count(self, token: Optional[str] = None) -> int:
-        """|coro|
-
-        Fetches a list of users that this user is following.
-
-        .. warning::
-
-            The endpoint this method uses has been deprecated by Twitch and is no longer available.
-
-        Parameters
-        -----------
-        token: Optional[:class:`str`]
-            An oauth token to use instead of the bots token
-
-        Returns
-        --------
-        :class:`int`
-        """
-        data = await self._http.get_follow_count(token=token, from_id=str(self.id))
-        return data["total"]
-
     async def fetch_channel_emotes(self):
         """|coro|
 
@@ -1771,6 +1633,146 @@ async def fetch_charity_campaigns(self, token: str) -> List[CharityCampaign]:
         data = await self._http.get_channel_charity_campaigns(str(self.id), token)
         return [CharityCampaign(d, self._http, self) for d in data]
 
+    # DEPRECATED
+
+    async def fetch_follow(self, to_user: "PartialUser", token: Optional[str] = None):
+        """|coro|
+
+        Check if a user follows another user or when they followed a user.
+
+        .. warning::
+
+            The endpoint this method uses has been deprecated by Twitch and is no longer available.
+
+        Parameters
+        -----------
+        to_user: :class:`PartialUser`
+        token: Optional[:class:`str`]
+            An oauth token to use instead of the bots token
+
+        Returns
+        --------
+        :class:`twitchio.FollowEvent`
+        """
+        if not isinstance(to_user, PartialUser):
+            raise TypeError(f"to_user must be a PartialUser not {type(to_user)}")
+        from .models import FollowEvent
+
+        data = await self._http.get_user_follows(token=token, from_id=str(self.id), to_id=str(to_user.id))
+        return FollowEvent(self._http, data[0]) if data else None
+
+    async def fetch_following(self, token: Optional[str] = None) -> List["FollowEvent"]:
+        """|coro|
+
+        Fetches a list of users that this user is following.
+
+        .. warning::
+
+            The endpoint this method uses has been deprecated by Twitch and is no longer available.
+
+        Parameters
+        -----------
+        token: Optional[:class:`str`]
+            An oauth token to use instead of the bots token
+
+        Returns
+        --------
+        List[:class:`twitchio.FollowEvent`]
+        """
+        from .models import FollowEvent
+
+        data = await self._http.get_user_follows(token=token, from_id=str(self.id))
+        return [FollowEvent(self._http, d, from_=self) for d in data]
+
+    async def fetch_followers(self, token: Optional[str] = None):
+        """|coro|
+
+        Fetches a list of users that are following this user.
+
+        .. warning::
+
+            The endpoint this method uses has been deprecated by Twitch and is no longer available.
+
+        Parameters
+        -----------
+        token: Optional[:class:`str`]
+            An oauth token to use instead of the bots token
+
+        Returns
+        --------
+        List[:class:`twitchio.FollowEvent`]
+        """
+        from .models import FollowEvent
+
+        data = await self._http.get_user_follows(token=token, to_id=str(self.id))
+        return [FollowEvent(self._http, d, to=self) for d in data]
+
+    async def fetch_follower_count(self, token: Optional[str] = None) -> int:
+        """|coro|
+
+        Fetches the total number of users that are following this user.
+
+        .. warning::
+
+            The endpoint this method uses has been deprecated by Twitch and is no longer available.
+
+        Parameters
+        -----------
+        token: Optional[:class:`str`]
+            An oauth token to use instead of the bots token
+
+        Returns
+        --------
+        :class:`int`
+        """
+
+        data = await self._http.get_follow_count(token=token, to_id=str(self.id))
+        return data["total"]
+
+    async def fetch_following_count(self, token: Optional[str] = None) -> int:
+        """|coro|
+
+        Fetches a list of users that this user is following.
+
+        .. warning::
+
+            The endpoint this method uses has been deprecated by Twitch and is no longer available.
+
+        Parameters
+        -----------
+        token: Optional[:class:`str`]
+            An oauth token to use instead of the bots token
+
+        Returns
+        --------
+        :class:`int`
+        """
+        data = await self._http.get_follow_count(token=token, from_id=str(self.id))
+        return data["total"]
+
+    async def fetch_ban_events(self, token: str, userids: List[int] = None):
+        """|coro|
+
+        This has been deprecated and will be removed in a future release.
+
+        Fetches ban/unban events from the User's channel.
+
+        Parameters
+        -----------
+        token: :class:`str`
+            The oauth token with the ``moderation:read`` scope.
+        userids: List[:class:`int`]
+            An optional list of users to fetch ban/unban events for
+
+        Returns
+        --------
+        List[:class:`twitchio.BanEvent`]
+        """
+        from .models import BanEvent
+
+        data = await self._http.get_channel_ban_unban_events(token, str(self.id), userids)
+        return [BanEvent(self._http, x, self) for x in data]
+
 
 class BitLeaderboardUser(PartialUser):
     __slots__ = "rank", "score"