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

Enforce usage messages #30

Closed
numberten opened this issue May 9, 2014 · 3 comments
Closed

Enforce usage messages #30

numberten opened this issue May 9, 2014 · 3 comments
Assignees
Milestone

Comments

@numberten
Copy link
Owner

For the sake of transparency for end users, it is best practice for all active components to have a usage message when invoked without any parameters. It would be convenient if this were enforced by the type system, instead of leaving it up to the component's implementer to remember to catch the edge case.

@numberten
Copy link
Owner Author

I think a good place for this might be adding an additional String parameter (the usage message) to command and commandT in Command.hs

@SWPhantom
Copy link
Collaborator

Wouldn't work with certain commands, like !oprah, obviously. Could we include a big help text? "!man"?

@numberten
Copy link
Owner Author

The commands in the Op component (!oprah, !ding, !ascend) use simpleCommandT for their construction. command and commandT are only used for components that require arguments.

I think a man/help component that displays a list of commands or information regarding the specific use of a individual command is a good idea. It could probably use its own issue.

@numberten numberten added this to the 1.0 milestone May 10, 2014
@numberten numberten self-assigned this May 10, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants