auto updated documentation

DavertMik · DavertMik · commit b12d2d9ee84a · 2018-07-16T11:53:38.000+03:00
diff --git a/_includes/extensions.md b/_includes/extensions.md
@@ -86,16 +86,18 @@ extensions:
 
 * `delete_successful` (default: true) - delete screenshots for successfully passed tests  (i.e. log only failed and errored tests).
 * `module` (default: WebDriver) - which module for screenshots to use. Set `AngularJS` if you want to use it with AngularJS module. Generally, the module should implement `Codeception\Lib\Interfaces\ScreenshotSaver` interface.
+* `ignore_steps` (default: []) - array of step names that should not be recorded, * wildcards supported
 
 
 #### Examples:
 
 ``` yaml
 extensions:
     enabled:
-        Codeception\Extension\Recorder:
+        - Codeception\Extension\Recorder:
             module: AngularJS # enable for Angular
             delete_successful: false # keep screenshots of successful tests
+            ignore_steps: [have, grab*]
 ```
 
 
diff --git a/changelog.markdown b/changelog.markdown
@@ -7,6 +7,20 @@ title: Codeception Changelog
 
 # Changelog
 
+#### 2.4.4
+
+* Recently added `extends` property in the `codeception.yml` and `*.suite.yml` files now support absolute paths; by **[silverfire](https://github.com/silverfire)**
+* Fixed absolute paths handling on Windows in ParamLoader; by **[silverfire](https://github.com/silverfire)**
+* **[Yii2]** Refactored database connection handling by **[SamMousa](https://github.com/SamMousa)**. Database connections should now always be closed after tests no matter how you have opened them or who is holding references to them. See  [#5045](https://github.com/Codeception/Codeception/issues/5045)
+* **[Symfony]** Email handling improved by **[mbohal](https://github.com/mbohal)**. Fixes [#5058](https://github.com/Codeception/Codeception/issues/5058).  
+    * Added optional argument `$expectedCount` to `seeEmailIsSent`
+    * Added `dontSeeEmailIsSent`
+* [Recorder Extension] Added `ignore_steps` option to disable recording of specific steps. By **[sspat](https://github.com/sspat)**.
+* **[WebDriver]** Fixed "No Session Timeout" fatal error by **[davertmik](https://github.com/davertmik)**.
+* **[WebDriver]** Added ability to locate clickable element by its title. See [#5065](https://github.com/Codeception/Codeception/issues/5065) by **[gimler](https://github.com/gimler)**  
+* **[Db]** Add `waitlock` config option for the database session to wait for lock in Oracle. By **[ashnazg](https://github.com/ashnazg)**. See [#5069](https://github.com/Codeception/Codeception/issues/5069)
+* **[REST]** Fixed `seeXmlResponseEquals` by **[Voziv](https://github.com/Voziv)**
+
 #### 2.4.3
 
 * [Create your own test formats](https://codeception.com/docs/07-AdvancedUsage#Formats) (e.g., Cept, Cest, ...); by **[mlambley](https://github.com/mlambley)**
diff --git a/docs/02-GettingStarted.md b/docs/02-GettingStarted.md
@@ -20,7 +20,7 @@ Codeception follows simple naming rules to make it easy to remember (as well as
     <?php
     $I->click('Login');
     $I->fillField('#input-username', 'John Dough');
-    $i->pressKey('#input-remarks', 'foo');
+    $I->pressKey('#input-remarks', 'foo');
     
 {% endhighlight %}
 * **Assertions** always start with "see" or "dontSee". Examples:
@@ -29,9 +29,9 @@ Codeception follows simple naming rules to make it easy to remember (as well as
     <?php
     $I->see('Welcome');
     $I->seeInTitle('My Company');
-    $i->seeElement('nav');
-    $i->dontSeeElement('#error-message');
-    $i->dontSeeInPageSource('<section class="foo">');
+    $I->seeElement('nav');
+    $I->dontSeeElement('#error-message');
+    $I->dontSeeInPageSource('<section class="foo">');
     
 {% endhighlight %}
 * **Grabbers** just *read* something from the page, but don't process it. The return value of those are meant to be saved as variables and used later. Example:
diff --git a/docs/modules/AngularJS.md b/docs/modules/AngularJS.md
@@ -151,7 +151,7 @@ $el = $module->_findClickable($topBar, 'Click Me');
 
 
 {% endhighlight %}
- * `param` $page WebDriver instance or an element to search within
+ * `param RemoteWebDriver` $page WebDriver instance or an element to search within
  * `param` $link a link text or locator to click
  * `return` WebDriverElement
 
diff --git a/docs/modules/Db.md b/docs/modules/Db.md
@@ -44,6 +44,7 @@ if you run into problems loading dumps and cleaning databases.
 * populate: false - whether the the dump should be loaded before the test suite is started
 * cleanup: false - whether the dump should be reloaded before each test
 * reconnect: false - whether the module should reconnect to the database before each test
+* waitlock: 0 - wait lock (in seconds) that the database session should use for DDL statements
 * ssl_key - path to the SSL key (MySQL specific, @see http://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-key)
 * ssl_cert - path to the SSL certificate (MySQL specific, @see http://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-cert)
 * ssl_ca - path to the SSL certificate authority (MySQL specific, @see http://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-ca)
@@ -60,6 +61,7 @@ if you run into problems loading dumps and cleaning databases.
              populate: true
              cleanup: true
              reconnect: true
+             waitlock: 10
              ssl_key: '/path/to/client-key.pem'
              ssl_cert: '/path/to/client-cert.pem'
              ssl_ca: '/path/to/ca-cert.pem'
diff --git a/docs/modules/Doctrine2.md b/docs/modules/Doctrine2.md
@@ -164,7 +164,7 @@ which will always return the NULL value.
 #### haveInRepository
  
 Persists record into repository.
-This method crates an entity, and sets its properties directly (via reflection).
+This method creates an entity, and sets its properties directly (via reflection).
 Setters of entity won't be executed, but you can create almost any entity and save it to database.
 Returns id using `getId` of newly created entity.
 
diff --git a/docs/modules/Laravel5.md b/docs/modules/Laravel5.md
@@ -631,7 +631,7 @@ $I->dontSeeFormErrors();
 
 {% endhighlight %}
 
- * `return` bool
+ * `return` void
 
 
 #### dontSeeInCurrentUrl
@@ -1197,8 +1197,9 @@ $user = $I->haveRecord('App\User', array('name' => 'Davert')); // returns Eloque
 {% endhighlight %}
 
  * `param string` $table
- * `param array` $attributes
- * `return` integer|EloquentModel
+ * `param array`  $attributes
+ * `return` EloquentModel|int
+@throws \RuntimeException
  * `[Part]` orm
 
 
@@ -1473,7 +1474,7 @@ $I->seeFormHasErrors();
 
 {% endhighlight %}
 
- * `return` bool
+ * `return` void
 
 
 #### seeInCurrentUrl
diff --git a/docs/modules/Symfony.md b/docs/modules/Symfony.md
@@ -476,6 +476,13 @@ $I->dontSeeElement('input', ['value' => '123456']);
  * `param array` $attributes
 
 
+#### dontSeeEmailIsSent
+ 
+Checks that no email was sent. This is an alias for seeEmailIsSent(0).
+
+ * `[Part]` email
+
+
 #### dontSeeInCurrentUrl
  
 Checks that the current URI doesn't contain the given string.
@@ -1031,9 +1038,18 @@ $I->seeElement(['css' => 'form input'], ['name' => 'login']);
 
 #### seeEmailIsSent
  
-Checks if any email were sent by last request
+Checks if the desired number of emails was sent.
+If no argument is provided then at least one email must be sent to satisfy the check.
+
+{% highlight php %}
+
+<?php
+$I->seeEmailIsSent(2);
+?>
+
+{% endhighlight %}
 
-@throws \LogicException
+ * `param null|int` $expectedCount
 
 
 #### seeInCurrentRoute
diff --git a/docs/modules/WebDriver.md b/docs/modules/WebDriver.md
@@ -364,7 +364,7 @@ $el = $module->_findClickable($topBar, 'Click Me');
 
 
 {% endhighlight %}
- * `param` $page WebDriver instance or an element to search within
+ * `param RemoteWebDriver` $page WebDriver instance or an element to search within
  * `param` $link a link text or locator to click
  * `return` WebDriverElement
 
diff --git a/docs/modules/Yii2.md b/docs/modules/Yii2.md
@@ -405,10 +405,6 @@ $I->click(['link' => 'Login']);
  * `param` $context
 
 
-#### connectionOpenHandler
-__not documented__
-
-
 #### createAndSetCsrfCookie
  
 This function creates the CSRF Cookie.
