Skip to content

Conversation

@H4ckerxx44
Copy link
Contributor

@H4ckerxx44 H4ckerxx44 commented Jul 9, 2022

Summary

Add embedded help command from nextcord#701

Checklist

  • If code changes were made then they have been tested.
    • I have updated the documentation to reflect the changes.
    • I have run task pyright and fixed the relevant issues.
  • This PR fixes an issue.
  • This PR adds something new (e.g. new method or parameters).
  • This PR is a breaking change (e.g. methods or parameters removed/renamed)
  • This PR is not a code change (e.g. documentation, README, ...)

Copy link
Contributor

@MaskDuck MaskDuck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

my ancestor told me that others are fine

@DenverCoder1
Copy link
Collaborator

The init file for the module should be updated so that this can be imported directly from nextcord.ext.help_commands

@DenverCoder1
Copy link
Collaborator

DenverCoder1 commented Jul 13, 2022

This is completely up to you since it's your help command design, but I'm thinking maybe cog help should show cog and command descriptions (command.short_doc)?

image

The first bot is what I currently use and the same as paginated.py in this lib and the Test bot is using yours.

I'm also noticing it does not have markdown support (or any descriptions having backticks). This is also fine if intended, but also something you may want to consider.

image

Additionally, I think this title is a bit long. Maybe the help [command] instruction would look better as part of the description or footer?

image

Feel free to take ideas from mine or leave things as is if you prefer.

@H4ckerxx44
Copy link
Contributor Author

H4ckerxx44 commented Jul 13, 2022

This is completely up to you since it's your help command design, but I'm thinking maybe cog help should show cog and command descriptions (command.short_doc)?

The problem is, what if there are many commands? Both solutions are pretty valid but I think for cogs that have more than a couple commands, the way I do it is better.

And actually, as this is no longer limited by the "the lib shouldn't do your work" part, I might as well give the current implementation a full redesign, my personal bot which I use with my friends has this command but way more upgraded, I will get to work on that and commit tonight / tomorrow.

@H4ckerxx44
Copy link
Contributor Author

H4ckerxx44 commented Jul 14, 2022

Main help command
main

Cog help command
cog

Group help command
group

Command help command
command

This EmbeddedHelpCommand has been set with

    bot.help_command = EmbeddedHelpCommand(main_embed_color=0x0000ff, main_embed_title="Main Help", main_embed_description="This is the help overview",
                                           command_embed_color=0x00ff00, command_embed_description="Command embed description", command_embed_title="Command embed title",
                                           group_embed_color=0x00ffff, group_embed_description="Group embed description", group_embed_title="Group embed title",
                                           cog_embed_color=0xff0000, cog_embed_description="Cog embed description", cog_embed_title="Cog embed title",
                                           dm_only=False)

Copy link

@Skelmis Skelmis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Untested but lgtm

@H4ckerxx44 H4ckerxx44 requested a review from DenverCoder1 July 18, 2022 18:55
@DenverCoder1 DenverCoder1 self-requested a review July 24, 2022 19:24
H4ckerxx44 and others added 4 commits July 24, 2022 21:43
Co-authored-by: MaskDuck <it-is@too-obvious-that.maskduck.is-a.dev>
Co-authored-by: MaskDuck <it-is@too-obvious-that.maskduck.is-a.dev>
@H4ckerxx44 H4ckerxx44 requested a review from DenverCoder1 July 30, 2022 12:23
@H4ckerxx44 H4ckerxx44 requested a review from Skelmis August 4, 2022 14:59
H4ckerxx44 and others added 2 commits August 8, 2022 15:21
Co-authored-by: teaishealthy <76410798+teaishealthy@users.noreply.github.com>
@DenverCoder1
Copy link
Collaborator

Thanks for your patience.

I think I'll merge it for now. The repo can always be enhanced and updated in the future. 👍

@DenverCoder1 DenverCoder1 merged commit a5e5cc2 into nextcord:master Aug 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants