diff --git a/ACKNOWLEDGEMENTS.txt b/ACKNOWLEDGEMENTS.txt index 47958aa..60af623 100644 --- a/ACKNOWLEDGEMENTS.txt +++ b/ACKNOWLEDGEMENTS.txt @@ -4,5 +4,9 @@ These are the open source libraries we use: - sphinx (https://github.com/sphinx-doc/sphinx) - furo (https://github.com/pradyunsg/furo) +These are users who have made a meaningful contribution to the development of the project: +- mxdcxt (One of the developers of the v3 module update) +- arslee07 (Updated logo of the project) + It is also important to note that some developments of Melisa (https://github.com/MelisaDev/melisa) were used in the development of the project. I would also like to express my gratitude to the former admin staff of the BotiCord (until 06/02/2023) and the entire project community. \ No newline at end of file diff --git a/README.md b/README.md index 8665698..8bcd01f 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ bot = commands.Bot(command_prefix="!") # Function that will return the current bot's stats. async def get_stats(): - return {"servers": len(bot.guilds), "shards": 0, "members": len(bot.users)} + return {"servers": len(bot.guilds), "shards": None, "members": len(bot.users)} # Function that will be called if stats are posted successfully. diff --git a/boticordpy/__init__.py b/boticordpy/__init__.py index a850f19..37bc003 100644 --- a/boticordpy/__init__.py +++ b/boticordpy/__init__.py @@ -10,7 +10,7 @@ __title__ = "boticordpy" __author__ = "Marakarka" __license__ = "MIT" __copyright__ = "Copyright 2021 - 2023 Marakarka" -__version__ = "3.0.1" +__version__ = "3.0.2" from .client import BoticordClient from .types import * diff --git a/boticordpy/autopost.py b/boticordpy/autopost.py index 02101b2..8f3d01d 100644 --- a/boticordpy/autopost.py +++ b/boticordpy/autopost.py @@ -9,7 +9,7 @@ _logger = logging.getLogger("boticord.autopost") class AutoPost: """ - You can use this class to post stats automatically. + You can use this to post stats automatically. Args: client (:obj:`~.client.BoticordClient`) @@ -109,6 +109,10 @@ class AutoPost: """ Registers a function that will return stats. Registered Function Must return dictionary. + .. warning:: + + None of the values must be equal to 0. Specify None instead of 0. + .. warning:: Callback functions must be a **coroutine**. If they aren't, then you might get unexpected diff --git a/boticordpy/client.py b/boticordpy/client.py index 51f4e1d..20aa2ae 100644 --- a/boticordpy/client.py +++ b/boticordpy/client.py @@ -60,6 +60,10 @@ class BoticordClient: ) -> boticord_types.ResourceBot: """Post Bot's stats. + .. warning:: + + None of the values must be equal to 0. Specify None instead of 0. + Args: bot_id (Union[:obj:`str`, :obj:`int`]) Id of the bot to post stats of. diff --git a/docs/source/conf.py b/docs/source/conf.py index bcf0853..04e7461 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -27,7 +27,7 @@ copyright = "2021 - 2023, Viktor K (Marakarka)" author = "Viktor K (Marakarka)" # The full version, including alpha/beta/rc tags -release = "3.0.1" +release = "3.0.2" # -- General configuration --------------------------------------------------- diff --git a/examples/autopost.py b/examples/autopost.py index 57afe50..04e8042 100644 --- a/examples/autopost.py +++ b/examples/autopost.py @@ -10,7 +10,7 @@ bot = commands.Bot(command_prefix="!") # Function that will return the current bot's stats. async def get_stats(): - return {"servers": len(bot.guilds), "shards": 0, "members": len(bot.users)} + return {"servers": len(bot.guilds), "shards": None, "members": len(bot.users)} # Function that will be called if stats are posted successfully.