Doc fix: clarify isMethodCacheable() returns true only for GET & HEAD

tamc · nicolas-grekas · commit d0ab719bedc9 · 2018-11-25T12:27:05.000+01:00
The current documentation points to https://tools.ietf.org/html/rfc7231#section-4.2.3. The spec says: "this specification defines GET, HEAD, and POST as cacheable, although the overwhelming majority of cache implementations only support GET and HEAD.". This fix to the documentation clarifies that Symfony follows majority (excluding POST) rather than the spec (including POST).
diff --git a/Request.php b/Request.php
@@ -1475,7 +1475,7 @@ public function isMethodSafe(/* $andCacheable = true */)
      *
      * @see https://tools.ietf.org/html/rfc7231#section-4.2.3
      *
-     * @return bool
+     * @return bool True for GET and HEAD, false otherwise
      */
     public function isMethodCacheable()
     {

Original file line number	Diff line number	Diff line change
`@@ -1475,7 +1475,7 @@ public function isMethodSafe(/* $andCacheable = true */)`
`1475`	`1475`	`*`
`1476`	`1476`	`* @see https://tools.ietf.org/html/rfc7231#section-4.2.3`
`1477`	`1477`	`*`
`1478`		`- * @return bool`
	`1478`	`+ * @return bool True for GET and HEAD, false otherwise`
`1479`	`1479`	`*/`
`1480`	`1480`	`public function isMethodCacheable()`
`1481`	`1481`	`{`