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.

Sign up for GitHub

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

Jump to bottom

[Help] description formatting #3380

Open
Stonedestroyer opened this issue Jan 16, 2020 · 1 comment
Open

[Help] description formatting #3380

Stonedestroyer opened this issue Jan 16, 2020 · 1 comment
Labels
Category: Core - Help This is related to our help command and/or HelpFormatter API. Status: Needs Discussion Needs more discussion. Type: Enhancement Something meant to enhance existing Red features.

Comments

@Stonedestroyer
Copy link
Contributor

Stonedestroyer commented Jan 16, 2020 •
edited by Jackenmen

Currently there is a few commands in Core that have backticks in their help description.

This makes it look very convuluted if not using embeds in the help descriptions. Example.
playlist start embed
playlist start non-embed
search embed
search non-embed

A suggestion that could work would be to strip backticks and all other offending characters when non-embeds. This would also prettify help menu when not using embeds.

Related:
https://github.com/Cog-Creators/Red-DiscordBot/pull/3374/files#r367337558 - Same issue with formatting here.
Draft PR that is related: #3379.
@Stonedestroyer Stonedestroyer added the Type: Bug Unexpected behavior, result, or exception. In case of PRs, it is a fix for the foregoing. label Jan 16, 2020
@github-actions github-actions bot added the Status: Needs Triage This has not been labeled or discussed for handling yet. label Jan 16, 2020
@Jackenmen Jackenmen added Status: In Progress There's a PR open to deal with this, or an org member is working on this internally Status: Needs Discussion Needs more discussion. Type: Enhancement Something meant to enhance existing Red features. and removed Status: Needs Triage This has not been labeled or discussed for handling yet. Type: Bug Unexpected behavior, result, or exception. In case of PRs, it is a fix for the foregoing. labels Jan 16, 2020
@Flame442
Copy link
Member

If something like this is implemented automatically in help, there needs to be some consideration for when characters that can be used as formatting are actually being used literally. A quick example is something like this:

[p]double <number>
Returns the result of number * 2.

@Jackenmen Jackenmen added Category: Bot Core Category: Core - Help This is related to our help command and/or HelpFormatter API. and removed Category: Bot Core labels Jan 16, 2020
@Jackenmen Jackenmen removed the Status: In Progress There's a PR open to deal with this, or an org member is working on this internally label Mar 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Category: Core - Help This is related to our help command and/or HelpFormatter API. Status: Needs Discussion Needs more discussion. Type: Enhancement Something meant to enhance existing Red features.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@Stonedestroyer @Jackenmen @Flame442