merged branch kriswallsmith/http/misleading-comment (PR #8886)

This PR was merged into the 2.3 branch.

Discussion
----------

fixed misleading doc block

This doc block does not match what's happening in the code.

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | ~
| License       | MIT
| Doc PR        | ~

Commits
-------

4d01e7e fixed misleading doc block
This commit is contained in:
Fabien Potencier 2013-08-30 13:37:51 +02:00
commit ce53700003

View File

@ -719,9 +719,9 @@ class Request
/**
* Returns the client IP addresses.
*
* The most trusted IP address is first, and the less trusted one last.
* The "real" client IP address is the last one, but this is also the
* less trusted one.
* The least trusted IP address is first, and the most trusted one last.
* The "real" client IP address is the first one, but this is also the
* least trusted one.
*
* Use this method carefully; you should use getClientIp() instead.
*