BoscoJared / BoscoJared/disparse

Support longer descriptions, using first sentence as short description

Open
#38 0 comments 0 reactions 1 assignee Claimed by @BoscoJared View on GitHub
Dominant language
Java
Stars
23
Forks
10
PR merge metrics
No merged PRs in 30d

Description

It's useful to have longer help descriptions for commands. It's useful to have short descriptions as a summary of commands.

Tools such as Javadoc and click allow long descriptions and use the first sentence as the short description.

On the help page for the full bot, use the first sentence of the description as a summary
On the help page for a specific command, use the full description (this also means it's probably better off not in the title of the embed, but just as plain text)

Also possible is supporting `summary` in the @CommandHandler, so that it can be explicitly given if preferred, but defaulting to the first sentence of `description` if it's not given.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.