CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 03:08:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

[Docs] Adds self recommendation to cog_data_path (#2539)

Browse Source 
This change adds the help text of "If calling from a command or method of your cog, this should be self." from `bundled_data_path` to `cog_data_path`. This bit of text can help people who are unsure of what a "cog instance" is to understand how to use `cog_data_path`.
This commit is contained in:
Flame442 2019-04-02 22:24:20 -04:00 committed by Will
parent de7d08ee75
commit 14a2f98418
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
redbot/core/data_manager.py
View File

@ -112,7 +112,8 @@ def cog_data_path(cog_instance=None, raw_name: str = None) -> Path:
Parameters Parameters
---------- ----------
cog_instance cog_instance
The instance of the cog you wish to get a data path for. The instance of the cog you wish to get a data path for.
If calling from a command or method of your cog, this should be ``self``.
raw_name : str raw_name : str
The name of the cog to get a data path for. The name of the cog to get a data path for.