submitSymfonyForm(): Mentioning name attribute (Codeception#128)

ThomasLandauer · web-flow · commit 259ee0ea67e6 · 2021-04-06T09:33:23.000-05:00
diff --git a/src/Codeception/Module/Symfony/BrowserAssertionsTrait.php b/src/Codeception/Module/Symfony/BrowserAssertionsTrait.php
@@ -83,8 +83,8 @@ public function seePageRedirectsTo(string $page, string $redirectsTo): void
     /**
      * Submit a form specifying the form name only once.
      *
-     * Use this function instead of $I->submitForm() to avoid repeating the form name in the field selectors.
-     * If you customized the names of the field selectors use $I->submitForm() for full control.
+     * Use this function instead of [`$I->submitForm()`](#submitForm) to avoid repeating the form name in the field selectors.
+     * If you customized the names of the field selectors use `$I->submitForm()` for full control.
      *
      * ```php
      * <?php
@@ -94,7 +94,7 @@ public function seePageRedirectsTo(string $page, string $redirectsTo): void
      * ]);
      * ```
      *
-     * @param string $name
+     * @param string $name The `name` attribute of the `<form>` (you cannot use an array as selector here)
      * @param string[] $fields
      */
     public function submitSymfonyForm(string $name, array $fields): void

Original file line number	Diff line number	Diff line change
`@@ -83,8 +83,8 @@ public function seePageRedirectsTo(string $page, string $redirectsTo): void`
`83`	`83`	`/**`
`84`	`84`	`* Submit a form specifying the form name only once.`
`85`	`85`	`*`
`86`		`- * Use this function instead of $I->submitForm() to avoid repeating the form name in the field selectors.`
`87`		`- * If you customized the names of the field selectors use $I->submitForm() for full control.`
	`86`	+ * Use this function instead of [`$I->submitForm()`](#submitForm) to avoid repeating the form name in the field selectors.
	`87`	+ * If you customized the names of the field selectors use `$I->submitForm()` for full control.
`88`	`88`	`*`
`89`	`89`	* ```php
`90`	`90`	`* <?php`
`@@ -94,7 +94,7 @@ public function seePageRedirectsTo(string $page, string $redirectsTo): void`
`94`	`94`	`* ]);`
`95`	`95`	* ```
`96`	`96`	`*`
`97`		`- * @param string $name`
	`97`	+ * @param string $name The `name` attribute of the `<form>` (you cannot use an array as selector here)
`98`	`98`	`* @param string[] $fields`
`99`	`99`	`*/`
`100`	`100`	`public function submitSymfonyForm(string $name, array $fields): void`