isle/tasks/soon/drafts/extended-sub-command-descriptions.md

16 lines
498 B
Markdown
Raw Permalink Normal View History

2024-12-12 19:20:27 +00:00
---
type: task
---
# Extended Sub-Command Descriptions
It might be useful to have some kind of extended description for each
sub-command, something that would be displayed only as part of `-h`.
The extended description could provide more context for what the sub-command is
for, and how it interact with other related sub-commands.
This could also be a good place to provide usage examples, although maybe those
should go in yet another section, EXAMPLES, to distinguish them from
DESCRIPTION.