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

[Help] Fixes some issues with fuzzy help (#2674)

Browse Source 
* Fixes some issues with fuzzy help

 - also cleans up some name shadowing which wasn't causing issues
 (curently)

* ver

* style
This commit is contained in:
Michael H 2019-05-15 02:52:06 -04:00 committed by Will
parent 2d22ee7ccc
commit 3c78fb420b
2 changed files with 22 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
redbot/__init__.py
View File

@ -174,7 +174,7 @@ class VersionInfo:
) )
__version__ = "3.1.0" __version__ = "3.1.1"
version_info = VersionInfo.from_str(__version__) version_info = VersionInfo.from_str(__version__)
# Filter fuzzywuzzy slow sequence matcher warning # Filter fuzzywuzzy slow sequence matcher warning

44
redbot/core/commands/help.py
View File

@ -271,8 +271,8 @@ class RedHelpFormatter:
async def format_cog_help(self, ctx: Context, obj: commands.Cog): async def format_cog_help(self, ctx: Context, obj: commands.Cog):
commands = await self.get_cog_help_mapping(ctx, obj) coms = await self.get_cog_help_mapping(ctx, obj)
if not (commands or self.CONFIRM_UNAVAILABLE_COMMAND_EXISTENCES): if not (coms or self.CONFIRM_UNAVAILABLE_COMMAND_EXISTENCES):
return return
description = obj.help description = obj.help
@ -285,9 +285,9 @@ class RedHelpFormatter:
if description: if description:
emb["embed"]["title"] = f"*{description[:2044]}*" emb["embed"]["title"] = f"*{description[:2044]}*"
if commands: if coms:
command_text = "\n".join( command_text = "\n".join(
f"**{name}** {command.short_doc}" for name, command in sorted(commands.items()) f"**{name}** {command.short_doc}" for name, command in sorted(coms.items())
) )
for i, page in enumerate(pagify(command_text, page_length=1000, shorten_by=0)): for i, page in enumerate(pagify(command_text, page_length=1000, shorten_by=0)):
if i == 0: if i == 0:
@ -300,11 +300,11 @@ class RedHelpFormatter:
await self.make_and_send_embeds(ctx, emb) await self.make_and_send_embeds(ctx, emb)
else: else:
commands_text = None subtext = None
commands_header = None subtext_header = None
if commands: if coms:
subtext_header = "Commands:" subtext_header = "Commands:"
max_width = max(discord.utils._string_width(name) for name in commands.keys()) max_width = max(discord.utils._string_width(name) for name in coms.keys())
def width_maker(cmds): def width_maker(cmds):
doc_max_width = 80 - max_width doc_max_width = 80 - max_width
@ -316,20 +316,17 @@ class RedHelpFormatter:
yield nm, doc, max_width - width_gap yield nm, doc, max_width - width_gap
subtext = "\n".join( subtext = "\n".join(
f" {name:<{width}} {doc}" f" {name:<{width}} {doc}" for name, doc, width in width_maker(coms.items())
for name, doc, width in width_maker(commands.items())
) )
to_page = "\n\n".join( to_page = "\n\n".join(filter(None, (description, subtext_header, subtext)))
filter(None, (description, signature[1:-1], subtext_header, subtext))
)
pages = [box(p) for p in pagify(to_page)] pages = [box(p) for p in pagify(to_page)]
await self.send_pages(ctx, pages, embed=False) await self.send_pages(ctx, pages, embed=False)
async def format_bot_help(self, ctx: Context): async def format_bot_help(self, ctx: Context):
commands = await self.get_bot_help_mapping(ctx) coms = await self.get_bot_help_mapping(ctx)
if not commands: if not coms:
return return
description = ctx.bot.description or "" description = ctx.bot.description or ""
@ -343,7 +340,7 @@ class RedHelpFormatter:
if description: if description:
emb["embed"]["title"] = f"*{description[:2044]}*" emb["embed"]["title"] = f"*{description[:2044]}*"
for cog_name, data in commands: for cog_name, data in coms:
if cog_name: if cog_name:
title = f"**__{cog_name}:__**" title = f"**__{cog_name}:__**"
@ -362,11 +359,12 @@ class RedHelpFormatter:
await self.make_and_send_embeds(ctx, emb) await self.make_and_send_embeds(ctx, emb)
else: else:
to_join = []
if description: if description:
to_join = [f"{description}\n"] to_join.append(f"{description}\n")
names = [] names = []
for k, v in commands: for k, v in coms:
names.extend(list(v.name for v in v.values())) names.extend(list(v.name for v in v.values()))
max_width = max( max_width = max(
@ -382,7 +380,7 @@ class RedHelpFormatter:
doc = doc[: doc_max_width - 3] + "..." doc = doc[: doc_max_width - 3] + "..."
yield nm, doc, max_width - width_gap yield nm, doc, max_width - width_gap
for cog_name, data in commands: for cog_name, data in coms:
title = f"{cog_name}:" if cog_name else "No Category:" title = f"{cog_name}:" if cog_name else "No Category:"
to_join.append(title) to_join.append(title)
@ -426,17 +424,17 @@ class RedHelpFormatter:
if fuzzy_commands: if fuzzy_commands:
ret = await format_fuzzy_results(ctx, fuzzy_commands, embed=use_embeds) ret = await format_fuzzy_results(ctx, fuzzy_commands, embed=use_embeds)
if use_embeds: if use_embeds:
ret.set_author() ret.set_author(name=f"{ctx.me.display_name} Help Menu", icon_url=ctx.me.avatar_url)
tagline = (await ctx.bot.db.help.tagline()) or self.get_default_tagline(ctx) tagline = (await ctx.bot.db.help.tagline()) or self.get_default_tagline(ctx)
ret.set_footer(text=tagline) ret.set_footer(text=tagline)
await ctx.send(embed=ret) await ctx.send(embed=ret)
else: else:
await ctx.send(ret) await ctx.send(ret)
elif self.CONFIRM_UNAVAILABLE_COMMAND_EXISTENCES: elif self.CONFIRM_UNAVAILABLE_COMMAND_EXISTENCES:
ret = T_("Command *{command_name}* not found.").format(command_name=command_name) ret = T_("Command *{command_name}* not found.").format(command_name=help_for)
if use_embeds: if use_embeds:
emb = discord.Embed(color=(await ctx.embed_color()), description=ret) ret = discord.Embed(color=(await ctx.embed_color()), description=ret)
emb.set_author(name=f"{ctx.me.display_name} Help Menu", icon_url=ctx.me.avatar_url) ret.set_author(name=f"{ctx.me.display_name} Help Menu", icon_url=ctx.me.avatar_url)
tagline = (await ctx.bot.db.help.tagline()) or self.get_default_tagline(ctx) tagline = (await ctx.bot.db.help.tagline()) or self.get_default_tagline(ctx)
ret.set_footer(text=tagline) ret.set_footer(text=tagline)
await ctx.send(embed=ret) await ctx.send(embed=ret)