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

Improve self-documentation of 3llo by adding a --help switch, show errors without confusing tracebacks #39

Merged
merged 1 commit into from
Aug 25, 2019

Conversation

Ma27
Copy link
Contributor

@Ma27 Ma27 commented Jul 28, 2019

This change adds a --help switch which prints the help text in an unindented version to make the program self-documenting. Also added a begin->rescue block around the environment validation to avoid printing confusing tracebacks with errors when invoking the program without any arguments the first time.

@Ma27
Copy link
Contributor Author

Ma27 commented Jul 28, 2019

Btw the build failure appears to be unrelated: when running gem install bundler, the resulting package doesn't support older ruby versions that are still listed in the CI matrix.

@qcam
Copy link
Owner

qcam commented Jul 29, 2019

@Ma27 Thank you for the PR, I left a few comments then I think we're good to go.

@Ma27
Copy link
Contributor Author

Ma27 commented Jul 30, 2019

THanks a lot for all the feedback! I'll do my best to fix that during one of the next days :)

@Ma27 Ma27 force-pushed the help-switch-and-colorized-warnings branch from 855ffd1 to 7667c67 Compare August 19, 2019 11:40
@Ma27
Copy link
Contributor Author

Ma27 commented Aug 19, 2019

@qcam @worldofpeace thanks for the review! Sorry for the delay, I addressed your comments, would you mind having another look? :)

@qcam qcam merged commit aba32bc into qcam:master Aug 25, 2019
@qcam
Copy link
Owner

qcam commented Aug 25, 2019

Thanks @Ma27 ❤️!

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

Successfully merging this pull request may close these issues.

3 participants