Help: add a list of subcommand necessary for some of the commands

Open
#4 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
38/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
ruby
Domain
cli

Research direction

Start at the entry point that builds the response to the help command and inspect how commands and their errors are represented. Run the help command to compare its current output with errors for commands that require subcommands. Done means the help message lists the necessary subcommands for those commands and remains readable.

Written by the indexing model from the issue text.

Description

new feature

For the help message in response to the 'help' command, I wonder if you'd considered adding a list of subcommand necessary for some of the commands. It's not always clear in the Help message that subcommands are needed for some of the commands, and what those might be, until the error message shows.

Dominant language
Ruby
Stars
18
Forks
1
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from slack-ruby/slack-api-explorer

All issues in slack-ruby/slack-api-explorer

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.