auto updated documentation

DavertMik · DavertMik · commit 7c541bad05c7 · 2017-05-27T02:33:02.000+02:00
diff --git a/_includes/extensions.md b/_includes/extensions.md
@@ -67,11 +67,9 @@ extensions:
 
 [See Source](https://github.com/Codeception/Codeception/blob/2.3/ext/Recorder.php)
 
-Saves a screenshot of each step in acceptance tests and shows them as a slideshow on one HTML page.
+Saves a screenshot of each step in acceptance tests and shows them as a slideshow on one HTML page (here's an [example](http://codeception.com/images/recorder.gif))
 Activated only for suites with WebDriver module enabled.
 
- ![recorder](http://codeception.com/images/recorder.gif)
-
 The screenshots are saved to `tests/_output/record_*` directories, open `index.html` to see them as a slideshow.
 
 #### Installation
diff --git a/changelog.markdown b/changelog.markdown
@@ -7,6 +7,13 @@ title: Codeception Changelog
 
 # Changelog
 
+#### 2.3.2
+
+* **[Db]** Fixed: Database has been cleaned up between tests even with `cleanup: false`.  
+* **[Db]** Made `dump` optional if `populator` is set. Fixes [#4247](https://github.com/Codeception/Codeception/issues/4247)
+* Fixed `generate:suite` command to create a directory for the suite. Fixes [#4251](https://github.com/Codeception/Codeception/issues/4251)
+* Fixed composer autoloading with PHPUnit 6 by **[enumag](https://github.com/enumag)**. See [#4262](https://github.com/Codeception/Codeception/issues/4262)
+
 #### 2.3.1
 
 * Updated composer constraints to include PHPUnit 6.x
diff --git a/docs/02-GettingStarted.md b/docs/02-GettingStarted.md
@@ -126,7 +126,7 @@ php codecept generate:scenarios
 
 {% endhighlight %}
 
-Generated scenarios will be stored in your `_output` directory in text files.
+These generated scenarios will be stored in your `_data` directory in text files.
 
 Before we execute this test, we should make sure that the website is running on a local web server.
 Let's open the `tests/acceptance.suite.yml` file and replace the URL with the URL of your web application:
diff --git a/docs/modules/Db.md b/docs/modules/Db.md
@@ -13,9 +13,7 @@ title: Db - Codeception - Documentation
 Access a database.
 
 The most important function of this module is to clean a database before each test.
-That's why this module was added to the global configuration file `codeception.yml`.
-To have your database properly cleaned you should configure it to access the database.
-This module also provides actions to perform checks in a database.
+This module also provides actions to perform checks in a database, e.g. [seeInDatabase()](http://codeception.com/docs/modules/Db#seeInDatabase)
 
 In order to have your database populated with data you need a raw SQL dump.
 Simply put the dump in the `tests/_data` directory (by default) and specify the path in the config.
diff --git a/docs/modules/Doctrine2.md b/docs/modules/Doctrine2.md
@@ -10,37 +10,37 @@ title: Doctrine2 - Codeception - Documentation
 # Doctrine2
 
 
-Allows integration and testing for projects with Doctrine2 ORM.
-Doctrine2 uses EntityManager to perform all database operations.
+Access the database using [Doctrine2 ORM](http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/).
 
-When using with Zend Framework 2 or Symfony2 Doctrine connection is automatically retrieved from Service Locator.
-In this case you should include either **Symfony** or **ZF2** module and specify it as dependent for Doctrine:
+When used with Zend Framework 2 or Symfony2, Doctrine's Entity Manager is automatically retrieved from Service Locator.
+Set up your `functional.suite.yml` like this:
 
 {% highlight yaml %}
 modules:
     enabled:
-        - Symfony
+        - Symfony # 'ZF2' or 'Symfony'
         - Doctrine2:
             depends: Symfony
+            cleanup: true # All doctrine queries will be wrapped in a transaction, which will be rolled back at the end of each test
 
 {% endhighlight %}
 
-If you don't use any of frameworks above, you should specify a callback function to receive entity manager:
+If you don't use Symfony or Zend Framework, you need to specify a callback function to retrieve the Entity Manager:
 
 {% highlight yaml %}
 modules:
     enabled:
         - Doctrine2:
             connection_callback: ['MyDb', 'createEntityManager']
+            cleanup: true # All doctrine queries will be wrapped in a transaction, which will be rolled back at the end of each test
 
 
 {% endhighlight %}
 
-This will use static method of `MyDb::createEntityManager()` to establish EntityManager.
+This will use static method of `MyDb::createEntityManager()` to establish the Entity Manager.
 
-By default module will wrap everything into transaction for each test and rollback it afterwards. By doing this
-tests won't write anything to database, and so will run much faster and will be isolate dfrom each other.
-This behavior can be changed by specifying `cleanup: false` in config.
+By default, the module will wrap everything into a transaction for each test and roll it back afterwards. By doing this
+tests will run much faster and will be isolated from each other.
 
 ### Status
 
@@ -50,17 +50,6 @@ This behavior can be changed by specifying `cleanup: false` in config.
 
 ### Config
 
-* cleanup: true - all doctrine queries will be run in transaction, which will be rolled back at the end of test.
-* connection_callback: - callable that will return an instance of EntityManager. This is a must if you run Doctrine without Zend2 or Symfony2 frameworks
-
- #### Example (`functional.suite.yml`)
-
-     modules:
-        enabled: [Doctrine2]
-        config:
-           Doctrine2:
-              cleanup: false
-
 ### Public Properties
 
 * `em` - Entity Manager
@@ -70,7 +59,7 @@ This behavior can be changed by specifying `cleanup: false` in config.
 
 #### dontSeeInRepository
  
-Flushes changes to database and performs ->findOneBy() call for current repository.
+Flushes changes to database and performs `findOneBy()` call for current repository.
 
  * `param` $entity
  * `param array` $params
@@ -92,7 +81,7 @@ Example:
 {% highlight php %}
 
 <?php
-$users = $I->grabEntitiesFromRepository('User', array('name' => 'davert'));
+$users = $I->grabEntitiesFromRepository('AppBundle:User', array('name' => 'davert'));
 ?>
 
 {% endhighlight %}
@@ -207,16 +196,15 @@ $I->persistEntity($user, array('name' => 'Miles'));
 
 #### seeInRepository
  
-Flushes changes to database executes a query defined by array.
-It builds query based on array of parameters.
+Flushes changes to database, and executes a query with parameters defined in an array.
 You can use entity associations to build complex queries.
 
 Example:
 
 {% highlight php %}
 
 <?php
-$I->seeInRepository('User', array('name' => 'davert'));
+$I->seeInRepository('AppBundle:User', array('name' => 'davert'));
 $I->seeInRepository('User', array('name' => 'davert', 'Company' => array('name' => 'Codegyre')));
 $I->seeInRepository('Client', array('User' => array('Company' => array('name' => 'Codegyre')));
 ?>
diff --git a/docs/reference/Module.md b/docs/reference/Module.md
@@ -73,7 +73,7 @@ Requires module container (to provide access between modules of suite) and confi
 
  * `param TestInterface` $test
 
-[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L257)
+[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L253)
 
 #### _afterStep()
 
@@ -83,15 +83,15 @@ Requires module container (to provide access between modules of suite) and confi
 
  * `param Step` $step
 
-[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L239)
+[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L235)
 
 #### _afterSuite()
 
  *public* _afterSuite() 
 
 **HOOK** executed after suite
 
-[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L221)
+[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L217)
 
 #### _before()
 
@@ -101,7 +101,7 @@ Requires module container (to provide access between modules of suite) and confi
 
  * `param TestInterface` $test
 
-[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L248)
+[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L244)
 
 #### _beforeStep()
 
@@ -111,7 +111,7 @@ Requires module container (to provide access between modules of suite) and confi
 
  * `param Step` $step
 
-[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L230)
+[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L226)
 
 #### _beforeSuite()
 
@@ -121,13 +121,7 @@ Requires module container (to provide access between modules of suite) and confi
 
  * `param array` $settings
 
-[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L214)
-
-#### _cleanup()
-
- *public* _cleanup() 
-
-[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L205)
+[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L210)
 
 #### _failed()
 
@@ -138,7 +132,7 @@ Requires module container (to provide access between modules of suite) and confi
  * `param TestInterface` $test
  * `param \Exception` $fail
 
-[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L267)
+[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L263)
 
 #### _getConfig()
 
@@ -149,7 +143,7 @@ Get config values or specific config item.
  * `param null` $key
  * `return` array|mixed|null
 
-[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L342)
+[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L338)
 
 #### _getName()
 
@@ -610,7 +604,7 @@ Print debug message to the screen.
 
  * `param` $message
 
-[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L276)
+[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L272)
 
 #### debugSection()
 
@@ -621,7 +615,7 @@ Print debug message with a title
  * `param` $title
  * `param` $message
 
-[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L287)
+[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L283)
 
 #### fail()
 
@@ -650,7 +644,7 @@ $this->getModule('WebDriver')->_findElements('.items');
  * `return` Module
  * `throws` ModuleException
 
-[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L328)
+[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L324)
 
 #### getModules()
 
@@ -659,7 +653,7 @@ $this->getModule('WebDriver')->_findElements('.items');
 Get all enabled modules
  * `return` array
 
-[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L311)
+[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L307)
 
 #### hasModule()
 
@@ -670,7 +664,7 @@ Checks that module is enabled.
  * `param` $name
  * `return` bool
 
-[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L301)
+[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L297)
 
 #### onReconfigure()
 
@@ -684,7 +678,7 @@ HOOK to be executed when config changes with `_reconfigure`.
 
  *protected* scalarizeArray($array) 
 
-[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L353)
+[See source](https://github.com/Codeception/Codeception/blob/2.3/src/Codeception/Module.php#L349)
 
 #### validateConfig()
 
