Skip to content

Consistent Error Responses #126

Closed
@pydis-bot

Description

@pydis-bot

Some errors use plain messages (e.g. general error handlers and moderation cogs) while others use embeds, sometimes even including humorous replies (e.g. reminders and clean cogs). Errors don't necessarily refer to CommandError here - it could be any error that is being handled, even ones that aren't exceptions.

Embeds have more formatting options, allow room for those humorous replies, and are more prominent in the sense that 1. bigger = more noticeable and 2. can't be confused for a regular user's message. On the other hand, plain messages have less clutter around them and are simpler to create in code (may be a moot point if a generic utility function is added to create the embeds).

  • Should the plain/embed be mutually exclusive? In other words, should everything only use one of them to stay consistent, or should some things be allowed use the other? If not, which should be used by what?
  • What style(s) should be used to stay consistent? Should the humorous replies always be used? Should plain messages always be prefixed by emojis?
  • Can and should a generic function be written to create these error messages? Refactoring out common pattern for sending errors #674 is doing that for embeds.

All the areas where errors are being handled should be identified so that it is clear what changes need to be made and where.

Originally posted by Kingsley McDonald:

many error responses in the Moderation cog aren't sent as an embed. instead, the messages are sent with a very simple (and ugly) ❌. all occurrences of this should be changed to be consistent with the rest of the bot's responses.

Metadata

Metadata

Assignees

Labels

a: frontendRelated to output and formattingp: 3 - lowLow Priorityt: featureNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions