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.

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

Should the ?Issues command have an optional param to pull more details on an individual issue? #75

Open
theboxmage opened this issue Jul 6, 2020 · 2 comments
Labels

Comments

@theboxmage
Copy link
Contributor

The code wouldn't be that hard to add an optional param to the Issues command.

Design Questions:

  • Expected format?
  • Same command or new one
  • Any issues if I split the run method to have 2 helper methods to generate the embed and have run just send the returned embed?

Example syntax would be ?issues codesupport/discord-bot 37

@ajsaraujo
Copy link
Contributor

In terms of usability, a single command is better. I mean...

# Different commands
?issue-by-id codesupport/discord-bot 37

# Same command
?issues codesupport/discord-bot 37

If we were to make two different commands, we could name them IssueCommand and IssuesCommand, it would keep the command name short, although it could also make things more confusing.

# 3 recentmost issues
?issues codesupport/discord-bot

# Get issue 37, must supply an issue id
?issue codesupport/discord-bot 37

I prefer having a single command. I also would like to leave the suggestion of adding issue as an alias for IssuesCommand if we choose to keep it in a single command.

I think that splitting the embed generation in two private methods is nice for readability, and the syntax you proposed is nice too.

@ajsaraujo ajsaraujo added command enhancement New feature or request good first issue Good for newcomers labels Jul 6, 2020
@theboxmage
Copy link
Contributor Author

Single command is fine to me, I forgot you could alias commands. I'll look into it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants