Skip to content

Commit

Permalink
document argument descs
Browse files Browse the repository at this point in the history
  • Loading branch information
taylorotwell committed Jun 7, 2015
1 parent 7eb0f23 commit b3c24be
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion artisan.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,10 +149,23 @@ In this example, the user may pass a value for the option like so:

php artisan email:send 1 --queue=default

Of course, you may also assign default values to options:
You may also assign default values to options:

email:send {user} {--queue=default}

#### Input Descriptions

You may assign descriptions to input arguments and options by separating the parameter from the description using a colon:

/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature = 'email:send
{user : The ID of the user}
{--queue= : Whether the job should be queued}';

<a name="retrieving-input"></a>
### Retrieving Input

Expand Down

0 comments on commit b3c24be

Please sign in to comment.