pull

Author: kiki7000

README.md

@@ -3,12 +3,12 @@
 [![PyPI version](https://badge.fury.io/py/discord-components.svg)](https://badge.fury.io/py/discord-components)
 [![Documentation Status](https://readthedocs.org/projects/discord-components/badge/?version=latest)](https://discord-components.readthedocs.io/)
 
-unofficial library for discord components(on development)
+An unofficial library for Discord components. (on development)
 
 - [GitHub](https://github.com/kiki7000/discord.py-components)
 - [Discord Server](https://discord.gg/pKM6stqPxS)
 
-## Install
+## Installation
 ```sh
 pip install --upgrade discord-components
 ```
@@ -53,9 +53,9 @@ bot.run("token")
 [The docs](https://discord-components.readthedocs.io/) can contain lot of spelling mistakes, grammar errors so if there is a problem please create an issue!
 
 ## Features
-+ Send, Edit discord components
++ Send, edit Discord components.
 + Get components interact event!
-+ Supports discord.ext.commands
++ Supports discord.py command extension.
 
 ## Helps
 + [Minibox](https://github.com/minibox24) - Button API explanation

discord_components/button.py

@@ -11,7 +11,7 @@
 
 
 class ButtonStyle:
-    """A class containing button styles"""
+    """Contains button styles."""
 
     blue = 1
     gray = 2
@@ -22,7 +22,7 @@ class ButtonStyle:
 
     @classmethod
     def randomColor(cls) -> int:
-        """Returns a random number between 1, 4
+        """Returns a random number between 1, 4.
 
         :returns: :class:`int`
         """
@@ -31,7 +31,7 @@ def randomColor(cls) -> int:
 
     @classmethod
     def to_dict(cls) -> dict:
-        """Returns a dict containing style information
+        """Returns a dict containing style information.
 
         :returns: :class:`dict`
         """
@@ -46,24 +46,24 @@ def to_dict(cls) -> dict:
 
 
 class Button(Component):
-    """The button class
+    """The button class.
 
     Parameters
     ----------
     label: :class:`str`
-        The bot's label
+        The button's label.
     style: :class:`int`
-        The bot's style (1 or more and 5 or less)
+        The button's style. (1 ~ 5)
     id: :class:`str`
         The button's id.
-
-        If this was not passed as an argument when initailized, this value is random
+        Defaults to :class:`ButtonStyle.gray`
     url: :class:`str`
-        The button's hyperlink.
+        The button's url.
     disabled: :class:`bool`
-        bool: If the buttons is disabled
+        bool: Indicates if the button is disabled.
+        Defaults to ``True``.
     emoji: :class:`discord.PartialEmoji`
-        The button's emoji
+        The button's emoji.
     """
 
     __slots__ = ("_style", "_label", "_id", "_url", "_disabled", "_emoji")
@@ -79,14 +79,14 @@ def __init__(
         emoji=None,
     ):
         if style == ButtonStyle.URL and not url:
-            raise InvalidArgument("You must provide a URL when the style is URL")
+            raise InvalidArgument("You must provide a URL when the style is set to URL.")
         if style == ButtonStyle.URL and id:
-            raise InvalidArgument("You musn't use both id and url")
+            raise InvalidArgument("Both ID and URL are set.")
         if not (1 <= style <= ButtonStyle.URL):
-            raise InvalidArgument(f"Style must be in between 1, {ButtonStyle.URL}")
+            raise InvalidArgument(f"Style must be between 1, {ButtonStyle.URL}.")
 
         if not len(str(label)) and not emoji:
-            raise InvalidArgument(f"Label or emoji must be given")
+            raise InvalidArgument(f"Label or emoji must be given.")
 
         self._style = style
         self._label = str(label)
@@ -109,7 +109,7 @@ def __init__(
 
     def to_dict(self) -> dict:
         """
-        Converts the button information required for API request to dict and returns
+        Gets the button information required for API request in dict form.
 
         :returns: :class:`dict`
         """
@@ -128,22 +128,22 @@ def to_dict(self) -> dict:
 
     @property
     def style(self) -> int:
-        """:class:`int`: The button's style (1 or more and 5 or less)"""
+        """:class:`int`: The button's style. (1 ~ 5)"""
         return self._style
 
     @property
     def label(self) -> str:
-        """:class:`str`: The button's label"""
+        """:class:`str`: The button's label."""
         return self._label
 
     @property
     def id(self) -> str:
-        """:class:`str`: The button's id."""
+        """:class:`str`: The button's ID."""
         return self._id
 
     @property
     def url(self) -> Optional[str]:
-        """Optional[:class:`str`]: The button's hyperlink.
+        """Optional[:class:`str`]: The button's URL.
 
         .. note::
             If the button's style is not `5`(URL), this value is `None`
@@ -152,41 +152,41 @@ def url(self) -> Optional[str]:
 
     @property
     def disabled(self) -> bool:
-        """:class:`bool`: If the buttons is disabled"""
+        """:class:`bool`: Indicates if the button is disabled."""
         return self._disabled
 
     @property
     def emoji(self) -> PartialEmoji:
-        """:class:`discord.PartialEmoji`: The button's emoji"""
+        """:class:`discord.PartialEmoji`: The button's emoji."""
         return self._emoji
 
     @style.setter
     def style(self, value: int):
         if value == ButtonStyle.URL and self.id:
-            raise InvalidArgument("You musn't use both id and url")
+            raise InvalidArgument("Both ID and URL are set.")
         if not (1 <= value <= ButtonStyle.URL):
-            raise InvalidArgument(f"Style must be in between 1, {ButtonStyle.URL}")
+            raise InvalidArgument(f"Style must be between 1, {ButtonStyle.URL}.")
 
         self._style = value
 
     @label.setter
     def label(self, value: str):
         if not len(str(value)) and not self.emoji:
-            raise InvalidArgument("Label musn't be empty")
+            raise InvalidArgument("Label should not be empty.")
 
         self._label = str(value)
 
     @url.setter
     def url(self, value: str):
         if value and self.style != ButtonStyle.URL:
-            raise InvalidArgument("button style is not URL")
+            raise InvalidArgument("Button style is not URL. You shouldn't provide URL.")
 
         self._url = value
 
     @id.setter
     def id(self, value: str):
         if self.style == ButtonStyle.URL:
-            raise InvalidArgument("button style is URL")
+            raise InvalidArgument("Button style is set to URL. You shouldn't provide ID.")
 
         self._id = value
 
@@ -203,14 +203,14 @@ def emoji(self, emoji: PartialEmoji):
 
     @staticmethod
     def from_json(data):
-        """Create button instance from json
+        """Creates button instance from json.
 
         :returns: :class:`~discord_components.Button`
 
         Parameters
         ----------
         data: :class:`dict`
-            The json
+            The json to construct button from.
         """
 
         emoji = data.get("emoji")

discord_components/client.py

@@ -30,25 +30,26 @@
 
 
 class DiscordComponents:
-    """discord_components client
+    """Represents discord_components client.
 
     Parameters
     ----------
     bot: Union[:class:`discord.Client`, :class:`discord.ext.commands.Bot`]
-        The bot
+        Discord client to use.
     change_discord_methods: Optional[:class:`bool`]
-        Default value set to True
 
-        Whether to change the methods of the discord module
+        Whether to override the methods of the discord.py module.
 
-        If this is enabled, you can just use :class:`await <Messageable>.send`, :class:`await <Context>.send` as :class:`await <DiscordButton>.send_button_msg`, :class:`await <Message>.edit`, as :class:`await <DiscordComponents>.edit_component_msg`
-
-        Also you can use `on_interact`
+        If this is enabled, you can just use
+        :class:`await <Messageable>.send`, :class:`await <Context>.send` as :class:`await <DiscordButton>.send_button_msg`,
+        :class:`await <Message>.edit`, as :class:`await <DiscordComponents>.edit_component_msg`
+        Alternatively, `on_interact` can be used.
+        Defaults to ``True``.
 
     Attributes
     ----------
     bot: Union[:class:`discord.Client`, :class:`discord.ext.commands.Bot`]
-        The bot
+        Discord client to use.
     """
 
     def __init__(self, bot, change_discord_methods=True):
@@ -58,7 +59,7 @@ def __init__(self, bot, change_discord_methods=True):
             self.change_discord_methods()
 
     def change_discord_methods(self):
-        """A function that change the methods of the discord module"""
+        """Overrides the methods of the discord.py module."""
 
         async def send_component_msg_prop(ctxorchannel, *args, **kwargs) -> Message:
             if isinstance(ctxorchannel, DContext):
@@ -100,16 +101,16 @@ async def send_component_msg(
         components=None,
         **options,
     ) -> Message:
-        """A function that sends a message with components
+        """Sends a message with components.
 
         :returns: :class:`discord.Message`
 
         Parameters
         ----------
         channel: :class:`discord.Messageable`
-            The channel to send the message
+            The channel to send the message.
         content: str
-            The message's content
+            The message's content.
         tts: :class:`bool`
             Indicates if the message should be sent using text-to-speech.
         embed: :class:`discord.Embed`
@@ -124,10 +125,10 @@ async def send_component_msg(
             If no object is passed at all then the defaults given by :attr:`discord.Client.allowed_mentions`
             are used instead.
         reference: Union[:class:`discord.Message`, :class:`discord.MessageReference`]
-            A reference to the Message to which you are replying.
+            A reference to the Message you are replying.
         components: List[Union[:class:`~discord_components.Component`, List[:class:`~discord_components.Component`]]]
             The components to send.
-            If this is 2-dimensional array, an array is a line
+            2-dimensional array can be used to send multiple lines of components.
         """
         state = self.bot._get_state()
         channel = await channel._get_channel()
@@ -148,7 +149,7 @@ async def send_component_msg(
                 reference = reference.to_message_reference_dict()
             except AttributeError:
                 raise InvalidArgument(
-                    "reference parameter must be Message or MessageReference"
+                    "Reference parameter must be either Message or MessageReference."
                 ) from None
 
         data = {
@@ -195,16 +196,16 @@ async def edit_component_msg(
         **options,
     ):
 
-        """A function that edits a message with components
+        """Edits a message with components.
 
         :returns: :class:`discord_components.ComponentMessage`
 
         Parameters
         ----------
         channel: :class:`discord.Messageable`
-            The channel to send the message
+            The channel to send the message.
         content: str
-            The message's content
+            The message's content.
         tts: :class:`bool`
             Indicates if the message should be sent using text-to-speech.
         embed: :class:`discord.Embed`
@@ -220,7 +221,7 @@ async def edit_component_msg(
             are used instead.
         components: List[Union[:class:`~discord_components.Component`, List[:class:`~discord_components.Component`]]]
             The components to send.
-            If this is 2-dimensional array, an array is a line
+            2-dimensional array can be used to send multiple lines of components.
         """
         state = self.bot._get_state()
 
@@ -376,7 +377,7 @@ async def fetch_component_message(self, message) -> ComponentMessage:
         Parameters
         ----------
         message: :class:`discord.Message`
-            The message to convert
+            The message to convert.
         """
 
         res = await self.bot.http.request(