Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the feedback commands (help & errors) more estethic and comprehensible #18

Closed
2 tasks done
s0lst1ce opened this issue May 8, 2019 · 12 comments
Closed
2 tasks done
Assignees
Labels
command issues related to bot commands enhancement New feature or request

Comments

@s0lst1ce
Copy link
Collaborator

s0lst1ce commented May 8, 2019

  • Error formatting
  • Interactive help command
@s0lst1ce s0lst1ce added enhancement New feature or request feature-change labels May 8, 2019
@s0lst1ce s0lst1ce self-assigned this May 8, 2019
@s0lst1ce s0lst1ce added this to the 0.2 milestone May 8, 2019
@s0lst1ce s0lst1ce pinned this issue Jun 3, 2019
@s0lst1ce s0lst1ce added command issues related to bot commands critical A critical issue that has to be fixed ASAP labels Oct 27, 2019
@s0lst1ce s0lst1ce changed the title Make the help command more estethic and comprehensible. Make the feedback commands (help & errors) more estethic and comprehensible Oct 29, 2019
@s0lst1ce
Copy link
Collaborator Author

s0lst1ce commented Oct 29, 2019

I was thinking that although nice the current error feedback messages weren't the best.
For example ERR_NOT_ENOUGH_ARG returns This command requires additional arguments. See ::help <command> to get more information on the command's usage"
A nicer way to do this would be to send an embed instead. Something in the likes of
image.

And we wouldn't even need to import discord in settings.py. Instead we could make all errors a tuple of (title, explanation). With a simple function we could easily send this feedback. What are your thoughts on this?

s0lst1ce added a commit that referenced this issue Oct 29, 2019
@s0lst1ce
Copy link
Collaborator Author

s0lst1ce commented Nov 6, 2019

Last comment's recommendations have been fully implemented.

s0lst1ce added a commit that referenced this issue Nov 6, 2019
@s0lst1ce
Copy link
Collaborator Author

s0lst1ce commented Nov 6, 2019

Although the help command is now fully implemented I think it could be made much better in a few ways:

  • allowing navigation through reactions
  • better formatting of the help pages

@s0lst1ce s0lst1ce removed the critical A critical issue that has to be fixed ASAP label Nov 6, 2019
@s0lst1ce s0lst1ce mentioned this issue Nov 6, 2019
2 tasks
@s0lst1ce
Copy link
Collaborator Author

s0lst1ce commented Nov 16, 2019

We will also need to rewrite some docstrings (see #66 ) because of how the arguments are now differentiated. The README will have to be updated too.

  • Update README

@s0lst1ce
Copy link
Collaborator Author

s0lst1ce commented Dec 7, 2019

FIXED: Something in the last commit makes it fail. Investigating...

@s0lst1ce s0lst1ce removed this from the v2 milestone Feb 17, 2020
@s0lst1ce
Copy link
Collaborator Author

Help pages should also contain command aliases.

@s0lst1ce
Copy link
Collaborator Author

s0lst1ce commented Feb 29, 2020

DONE: They should also contain page numbering.

@s0lst1ce
Copy link
Collaborator Author

s0lst1ce commented Mar 1, 2020

Currently doesn't support help in DMs

@s0lst1ce
Copy link
Collaborator Author

s0lst1ce commented Mar 1, 2020

For now it has been chosen that anyone will be able to react on anyone's help pages. This is an issue but will be fixed later. If any of you have ideas on how to prevent this I'm open to suggestions.

@s0lst1ce
Copy link
Collaborator Author

s0lst1ce commented Mar 1, 2020

Group and cog description currently only support up to one page.

@s0lst1ce
Copy link
Collaborator Author

s0lst1ce commented Mar 1, 2020

Maybe it would be better to turn the various get_pages functions into generators so that they only fetch the required pages. We would have to pre-calculate the pages though and store them so that they are not re-generated.

s0lst1ce added a commit that referenced this issue Mar 2, 2020
@s0lst1ce s0lst1ce unpinned this issue Mar 6, 2020
@Botanism Botanism locked as resolved and limited conversation to collaborators Mar 6, 2020
@s0lst1ce
Copy link
Collaborator Author

s0lst1ce commented Apr 4, 2020

This is done, still a few possible improvement but this issue is fixed.

@s0lst1ce s0lst1ce closed this as completed Apr 4, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
command issues related to bot commands enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant