minor #47026 Explain status codes in comments (alexislefebvre)

fabpot · fabpot · commit b2cd4543a250 · 2022-07-22T14:56:53.000+02:00
This PR was merged into the 6.2 branch. Discussion ---------- Explain status codes in comments | Q | A | ------------- | --- | Branch? | 6.2 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | | License | MIT | Doc PR | These comments will help users to understand the usage of each status code by being explicit about the code and the message. So that developers who don't remember what `200` and `302` mean can understand it directly. I took some inspiration from this line: https://github.com/symfony/symfony/blob/7463344ecdac6fdd6e6a1d86d344b93ddf7cdda9/src/Symfony/Component/HttpFoundation/RedirectResponse.php#L28 Replace #47025 Commits ------- 8734d222b4 Explain status codes in comments
diff --git a/HttpUtils.php b/HttpUtils.php
@@ -49,7 +49,7 @@ public function __construct(UrlGeneratorInterface $urlGenerator = null, UrlMatch
      * Creates a redirect Response.
      *
      * @param string $path   A path (an absolute path (/foo), an absolute URL (http://...), or a route name (foo))
-     * @param int    $status The status code
+     * @param int    $status The HTTP status code (302 "Found" by default)
      */
     public function createRedirectResponse(Request $request, string $path, int $status = 302): RedirectResponse
     {

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ public function __construct(UrlGeneratorInterface $urlGenerator = null, UrlMatch`
`49`	`49`	`* Creates a redirect Response.`
`50`	`50`	`*`
`51`	`51`	`* @param string $path A path (an absolute path (/foo), an absolute URL (http://...), or a route name (foo))`
`52`		`- * @param int $status The status code`
	`52`	`+ * @param int $status The HTTP status code (302 "Found" by default)`
`53`	`53`	`*/`
`54`	`54`	`public function createRedirectResponse(Request $request, string $path, int $status = 302): RedirectResponse`
`55`	`55`	`{`