Merge pull request #1584 from bpierre/bug/doc-fixes

Documentation fixes
This commit is contained in:
Taylor Otwell 2013-01-10 14:03:46 -08:00
commit 3b8d8bbf77
13 changed files with 25 additions and 25 deletions

View File

@ -10,7 +10,7 @@ ## Contents
<a name="the-basics"></a>
## The Basics
Laravel's command-line tool is called Artisan. Artisan can be used to run "tasks" such as migrations, cronjobs, unit-tests, or anything that want.
Laravel's command-line tool is called Artisan. Artisan can be used to run "tasks" such as migrations, cronjobs, unit-tests, or anything that you want.
<a name="creating-tasks"></a>
## Creating & Running Tasks
@ -23,7 +23,7 @@ #### Creating a task class:
public function run($arguments)
{
// Do awesome notifying...
// Do awesome notifying
}
}
@ -42,7 +42,7 @@ #### Calling a task from your application:
Command::run(array('notify'));
#### Calling a task from your application with arguements:
#### Calling a task from your application with arguments:
Command::run(array('notify', 'taylor'));
@ -54,7 +54,7 @@ #### Adding a method to the task:
public function run($arguments)
{
// Do awesome notifying...
// Do awesome notifying
}
public function urgent($arguments)

View File

@ -116,7 +116,7 @@ #### Listen for a bundle's start event:
Event::listen('laravel.started: admin', function()
{
// The "admin" bundle has started...
// The "admin" bundle has started
});
It is also possible to "disable" a bundle so that it will never be started.

View File

@ -315,7 +315,7 @@ ### Upgrading From 3.1.4
## Laravel 3.1.4
- Fixes Response header casing bug.
- Fixes SQL "where in" (...) short-cut bug.
- Fixes SQL "where in" () short-cut bug.
<a name="upgrade-3.1.4"></a>
### Upgrading From 3.1.3

View File

@ -88,8 +88,8 @@ ## Committing
# git commit -s -m "I added some more stuff to the Localization documentation."
"- **-s** means that you are signing-off on your commit with your name. This tells the Laravel team know that you personally agree to your code being added to the Laravel core.
"- **-m** is the message that goes with your commit. Provide a brief explanation of what you added or changed.
- **-s** means that you are signing-off on your commit with your name. This tells the Laravel team know that you personally agree to your code being added to the Laravel core.
- **-m** is the message that goes with your commit. Provide a brief explanation of what you added or changed.
<a name="pushing-to-your-fork"></a>
## Pushing to your Fork

View File

@ -28,7 +28,7 @@ ## Cloning Laravel
Open up Windows Explorer and create a new directory where you can make development changes to Laravel.
- Right-click the Laravel directory to bring up the context menu. Click on **Git Clone...**
- Right-click the Laravel directory to bring up the context menu. Click on **Git Clone**
- Git clone
- **Url:** https://github.com/laravel/laravel.git
- **Directory:** the directory that you just created in the previous step
@ -73,7 +73,7 @@ ## Creating Branches
Now that you have finished coding and testing your changes, it's time to commit them to your local repository:
- Right-click the Laravel directory and goto **Git Commit -> "feature/localization-docs"...**
- Right-click the Laravel directory and goto **Git Commit -> "feature/localization-docs"**
- Commit
- **Message:** Provide a brief explaination of what you added or changed
- Click **Sign** - This tells the Laravel team know that you personally agree to your code being added to the Laravel core
@ -85,7 +85,7 @@ ## Pushing to your Fork
Now that your local repository has your committed changes, it's time to push (or sync) your new branch to your fork that is hosted in GitHub:
- Right-click the Laravel directory and goto **Git Sync...**
- Right-click the Laravel directory and goto **Git Sync**
- Git Syncronization
- **Local Branch:** feature/localization-docs
- **Remote Branch:** leave this blank

View File

@ -140,7 +140,7 @@ #### Access the "index" action of the controller:
<a name="controller-layouts"></a>
## Controller Layouts
Full documentation on using layouts with Controllers [can be found on the Templating page](http://laravel.com/docs/views/templating).
Full documentation on using layouts with Controllers [can be found on the Templating page](/docs/views/templating).
<a name="restful-controllers"></a>
## RESTful Controllers

View File

@ -425,7 +425,7 @@ ## Eager Loading
SELECT * FROM "books"
SELECT * FROM "authors" WHERE "id" IN (1, 2, 3, 4, 5, ...)
SELECT * FROM "authors" WHERE "id" IN (1, 2, 3, 4, 5, )
Obviously, wise use of eager loading can dramatically increase the performance of your application. In the example above, eager loading cut the execution time in half.

View File

@ -41,7 +41,7 @@ #### Using a Closure to return a default value:
#### Determining if the input contains a given item:
if (Input::has('name')) ...
if (Input::has('name'))
> **Note:** The "has" method will return *false* if the input item is an empty string.

View File

@ -85,7 +85,7 @@ ### Services
public static function validate(Location $location)
{
// Validate the location instance...
// Validate the location instance
}
}
@ -104,7 +104,7 @@ ### Repositories
public function save(Location $location, $user_id)
{
// Store the location for the given user ID...
// Store the location for the given user ID
}
}

View File

@ -286,7 +286,7 @@ #### Determine if an attribute has an error message:
if ($validation->errors->has('email'))
{
// The e-mail attribute has errors...
// The e-mail attribute has errors
}
#### Retrieve the first error message for an attribute:
@ -327,7 +327,7 @@ ## Validation Walkthrough
Route::post('register', function()
{
$rules = array(...);
$rules = array();
$validation = Validator::make(Input::all(), $rules);
@ -438,13 +438,13 @@ #### Registering a custom validation rule:
As mentioned above, you may even specify and receive a list of parameters in your custom rule:
// When building your rules array...
// When building your rules array
$rules = array(
'username' => 'required|awesome:yes',
);
// In your custom rule...
// In your custom rule
Validator::register('awesome', function($attribute, $value, $parameters)
{

View File

@ -184,7 +184,7 @@ #### Register a composer that handles multiple views:
<a name="redirects"></a>
## Redirects
It's important to note that both routes and controllers require responses to be returned with the 'return' directive. Instead of calling "Redirect::to()"" where you'd like to redirect the user. You'd instead use "return Redirect::to()". This distinction is important as it's different than most other PHP frameworks and it could be easy to accidentally overlook the importance of this practice.
It's important to note that both routes and controllers require responses to be returned with the 'return' directive. Instead of calling "Redirect::to()" where you'd like to redirect the user. You'd instead use "return Redirect::to()". This distinction is important as it's different than most other PHP frameworks and it could be easy to accidentally overlook the importance of this practice.
#### Redirecting to another URI:

View File

@ -38,7 +38,7 @@ #### Generate the pagination links:
The links method will create an intelligent, sliding list of page links that looks something like this:
Previous 1 2 ... 24 25 26 27 28 29 30 ... 78 79 Next
Previous 1 2 … 24 25 26 27 28 29 30 … 78 79 Next
The Paginator will automatically determine which page you're on and update the results and links accordingly.
@ -86,7 +86,7 @@ ## Pagination Styling
<li><a href="foo">1</a></li>
<li><a href="foo">2</a></li>
<li class="dots disabled"><a href="#">...</a></li>
<li class="dots disabled"><a href="#"></a></li>
<li><a href="foo">11</a></li>
<li><a href="foo">12</a></li>
@ -96,7 +96,7 @@ ## Pagination Styling
<li><a href="foo">14</a></li>
<li><a href="foo">15</a></li>
<li class="dots disabled"><a href="#">...</a></li>
<li class="dots disabled"><a href="#"></a></li>
<li><a href="foo">25</a></li>
<li><a href="foo">26</a></li>

View File

@ -152,7 +152,7 @@ #### Unless Statement:
Login
@endunless
// Equivalent to...
// Equivalent to
<?php if ( ! Auth::check()): ?>
Login