From 14a2f98418bba28d27f55196ba3cb957fe728e36 Mon Sep 17 00:00:00 2001 From: Flame442 <34169552+Flame442@users.noreply.github.com> Date: Tue, 2 Apr 2019 22:24:20 -0400 Subject: [PATCH] [Docs] Adds `self` recommendation to `cog_data_path` (#2539) 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`. --- redbot/core/data_manager.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/redbot/core/data_manager.py b/redbot/core/data_manager.py index 3faf00b33..cc2bd3263 100644 --- a/redbot/core/data_manager.py +++ b/redbot/core/data_manager.py @@ -112,7 +112,8 @@ def cog_data_path(cog_instance=None, raw_name: str = None) -> Path: Parameters ---------- 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 The name of the cog to get a data path for.