Docs Command Line Arguments for Generators #27386

Merged
merged 1 commit into from Dec 16, 2016

Projects

None yet

5 participants

@kevinhughes27
Contributor

Summary

This PR adds a documentation section explaining how to add command line arguments to Rails generators. This functionality comes from Thor but I think its worth having a section in the Rails guide since it took some extra time to figure how to do this correctly.

Here is an example generator where I used command line arguments like this:
https://github.com/Shopify/shopify_app/blob/master/lib/generators/shopify_app/install/install_generator.rb

@kevinhughes27 kevinhughes27 [ci skip] add a section explaining command line arguments for generators 5578ce4
@arthurnn arthurnn was assigned by rails-bot Dec 16, 2016
@rails-bot

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @arthurnn (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

@rafaelfranca rafaelfranca merged commit e55fac5 into rails:master Dec 16, 2016

1 check passed

codeclimate no new or fixed issues
Details
@maclover7 maclover7 added the docs label Dec 16, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment