Standardize "@example.com" as domain in documentation (#124)

ThomasLandauer · web-flow · commit 6be648a6f8c1 · 2021-03-16T08:31:33.000-05:00
diff --git a/src/Codeception/Module/Symfony.php b/src/Codeception/Module/Symfony.php
@@ -110,7 +110,7 @@
  *         - Doctrine2:
  *             depends: Symfony
  *         - WebDriver:
- *             url: http://your-url.com
+ *             url: http://example.com
  *             browser: firefox
  * ```
  *
diff --git a/src/Codeception/Module/Symfony/BrowserAssertionsTrait.php b/src/Codeception/Module/Symfony/BrowserAssertionsTrait.php
@@ -89,7 +89,7 @@ public function seePageRedirectsTo(string $page, string $redirectsTo): void
      * ```php
      * <?php
      * $I->submitSymfonyForm('login_form', [
-     *     '[email]'    => 'john_doe@gmail.com',
+     *     '[email]'    => 'john_doe@example.com',
      *     '[password]' => 'secretForest'
      * ]);
      * ```
@@ -110,4 +110,4 @@ public function submitSymfonyForm(string $name, array $fields): void
 
         $this->submitForm($selector, $params, $button);
     }
-}
+}
diff --git a/src/Codeception/Module/Symfony/MailerAssertionsTrait.php b/src/Codeception/Module/Symfony/MailerAssertionsTrait.php
@@ -48,7 +48,7 @@ public function seeEmailIsSent(int $expectedCount = 1): void
      * <?php
      * $email = $I->grabLastSentEmail();
      * $address = $email->getTo()[0];
-     * $I->assertSame('john_doe@user.com', $address->getAddress());
+     * $I->assertSame('john_doe@example.com', $address->getAddress());
      * ```
      *
      * @return \Symfony\Component\Mime\Email|null
@@ -72,8 +72,6 @@ public function grabLastSentEmail(): ?Email
      * ```php
      * <?php
      * $emails = $I->grabSentEmails();
-     * $address = $emails[0]->getTo()[0];
-     * $I->assertSame('john_doe@user.com', $address->getAddress());
      * ```
      *
      * @return \Symfony\Component\Mime\Email[]
diff --git a/src/Codeception/Module/Symfony/SessionAssertionsTrait.php b/src/Codeception/Module/Symfony/SessionAssertionsTrait.php
@@ -23,7 +23,7 @@ trait SessionAssertionsTrait
      * ```php
      * <?php
      * $user = $I->grabEntityFromRepository(User::class, [
-     *     'email' => 'john_doe@gmail.com'
+     *     'email' => 'john_doe@example.com'
      * ]);
      * $I->amLoggedInAs($user);
      * ```
@@ -168,4 +168,4 @@ protected function grabSessionService(): SessionInterface
     {
         return $this->grabService('session');
     }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@`
`110`	`110`	`* - Doctrine2:`
`111`	`111`	`* depends: Symfony`
`112`	`112`	`* - WebDriver:`
`113`		`- * url: http://your-url.com`
	`113`	`+ * url: http://example.com`
`114`	`114`	`* browser: firefox`
`115`	`115`	* ```
`116`	`116`	`*`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ trait SessionAssertionsTrait`
`23`	`23`	* ```php
`24`	`24`	`* <?php`
`25`	`25`	`* $user = $I->grabEntityFromRepository(User::class, [`
`26`		`- * 'email' => 'john_doe@gmail.com'`
	`26`	`+ * 'email' => 'john_doe@example.com'`
`27`	`27`	`* ]);`
`28`	`28`	`* $I->amLoggedInAs($user);`
`29`	`29`	* ```
`@@ -168,4 +168,4 @@ protected function grabSessionService(): SessionInterface`
`168`	`168`	`{`
`169`	`169`	`return $this->grabService('session');`
`170`	`170`	`}`
`171`		`-}`
	`171`	`+}`