Merge pull request Codeception#190 from Codeception/routine-documentation-update

Naktibalda · web-flow · commit e8d361eab2b4 · 2019-11-15T19:50:08.000+02:00
Routine documentation update
diff --git a/RoboFile.php b/RoboFile.php
@@ -280,7 +280,7 @@ function (\ReflectionMethod $m, $doc) {
     public function buildDocsApi()
     {
         $this->say("API Classes");
-        $apiClasses = ['Codeception\Module', 'Codeception\InitTemplate'];
+        $apiClasses = ['\Codeception\Module', '\Codeception\InitTemplate'];
 
         foreach ($apiClasses as $apiClass) {
             $name = (new ReflectionClass($apiClass))->getShortName();
diff --git a/docs/modules/Asserts.md b/docs/modules/Asserts.md
@@ -370,6 +370,16 @@ __not documented__
 __not documented__
 
 
+#### assertStringEndsNotWith
+ 
+ * `Available since` 1.1.0 of module-asserts
+
+
+#### assertStringEndsWith
+ 
+ * `Available since` 1.1.0 of module-asserts
+
+
 #### assertStringNotContainsString
 __not documented__
 
diff --git a/docs/modules/Doctrine2.md b/docs/modules/Doctrine2.md
@@ -39,8 +39,24 @@ modules:
 
 This will use static method of `MyDb::createEntityManager()` to establish the Entity Manager.
 
-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.
+By default, the module will wrap everything into a transaction for each test and roll it back afterwards
+(this is controlled by the `cleanup` setting).
+By doing this, tests will run much faster and will be isolated from each other.
+
+To use the Doctrine2 Module in acceptance tests, set up your `acceptance.suite.yml` like this:
+
+{% highlight yaml %}
+
+modules:
+    enabled:
+        - Symfony:
+            part: SERVICES
+        - Doctrine2:
+            depends: Symfony
+``
+
+You cannot use `cleanup: true` in an acceptance test, since Codeception and your app (i.e. browser) are using two
+different connections to the database, so Codeception can't wrap changes made by the app into a transaction.
 
 ### Status
 
@@ -60,16 +76,15 @@ Every method that expects some parameters to be checked against values in the da
 `dontSee...()`, `grab...()`) can accept instance of \Doctrine\Common\Collections\Criteria for more
 flexibility, e.g.:
 
-{% highlight php %}
 
+{% endhighlight %} php
 $I->seeInRepository('User', [
     'name' => 'John',
     Criteria::create()->where(
         Criteria::expr()->endsWith('email', '@domain.com')
     ),
 ]);
-
-{% endhighlight %}
+```
 
 If criteria is just a `->where(...)` construct, you can pass just expression without criteria wrapper:
 
diff --git a/docs/reference/InitTemplate.md b/docs/reference/InitTemplate.md
@@ -34,13 +34,13 @@ This class provides various helper methods for building customized setup
 
  *public* __construct($input, $output) 
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L65)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L65)
 
 #### addStyles()
 
  *public* addStyles($output) 
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L9)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L9)
 
 #### ask()
 
@@ -64,25 +64,25 @@ $this->ask('do you want to proceed (y/n)', true);
  * `param null` $answer
  * `return` mixed|string
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L107)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L107)
 
 #### breakParts()
 
  *protected* breakParts($class) 
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L6)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L6)
 
 #### checkInstalled()
 
  *protected* checkInstalled($dir = null) 
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L208)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L208)
 
 #### completeSuffix()
 
  *protected* completeSuffix($filename, $suffix) 
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L25)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L25)
 
 #### createActor()
 
@@ -95,13 +95,13 @@ Requires a suite config as array in 3rd parameter.
  * `param` $directory
  * `param` $suiteConfig
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L223)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L223)
 
 #### createDirectoryFor()
 
  *protected* createDirectoryFor($basePath, $className = null) 
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L10)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L10)
 
 #### createEmptyDirectory()
 
@@ -110,13 +110,13 @@ Requires a suite config as array in 3rd parameter.
 Create an empty directory and add a placeholder file into it
  * `param` $dir
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L195)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L195)
 
 #### createFile()
 
  *protected* createFile($filename, $contents, $force = null, $flags = null) 
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L46)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L46)
 
 #### createHelper()
 
@@ -127,51 +127,51 @@ Create a helper class inside a directory
  * `param` $name
  * `param` $directory
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L174)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L174)
 
 #### getNamespaceHeader()
 
  *protected* getNamespaceHeader($class) 
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L31)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L31)
 
 #### getNamespaceString()
 
  *protected* getNamespaceString($class) 
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L25)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L25)
 
 #### getNamespaces()
 
  *protected* getNamespaces($class) 
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L40)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L40)
 
 #### getShortClassName()
 
  *protected* getShortClassName($class) 
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L19)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L19)
 
 #### gitIgnore()
 
  *protected* gitIgnore($path) 
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L201)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L201)
 
 #### initDir()
 
  *public* initDir($workDir) 
 
 Change the directory where Codeception should be installed.
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L75)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L75)
 
 #### removeSuffix()
 
  *protected* removeSuffix($classname, $suffix) 
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L40)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L40)
 
 #### say()
 
@@ -189,7 +189,7 @@ $this->say('Welcome to Setup');
 
  * `param string` $message
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L136)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L136)
 
 #### sayInfo()
 
@@ -198,7 +198,7 @@ $this->say('Welcome to Setup');
 Print info message
  * `param` $message
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L163)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L163)
 
 #### saySuccess()
 
@@ -207,7 +207,7 @@ Print info message
 Print a successful message
  * `param` $message
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L145)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L145)
 
 #### sayWarning()
 
@@ -216,7 +216,7 @@ Print a successful message
 Print warning message
  * `param` $message
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L154)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L154)
 
 #### setup()
 
@@ -225,6 +225,6 @@ Print warning message
 Override this class to create customized setup.
  * `return` mixed
 
-[See source](https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php#L88)
+[See source](https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php#L88)
 
-<p>&nbsp;</p><div class="alert alert-warning">Reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/blob/4.0/srcCodeception/InitTemplate.php">Help us to improve documentation. Edit module reference</a></div>
+<p>&nbsp;</p><div class="alert alert-warning">Reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/blob/4.0/src/Codeception/InitTemplate.php">Help us to improve documentation. Edit module reference</a></div>
diff --git a/docs/reference/Module.md b/docs/reference/Module.md

Original file line number	Diff line number	Diff line change
`@@ -280,7 +280,7 @@ function (\ReflectionMethod $m, $doc) {`
`280`	`280`	`public function buildDocsApi()`
`281`	`281`	`{`
`282`	`282`	`$this->say("API Classes");`
`283`		`- $apiClasses = ['Codeception\Module', 'Codeception\InitTemplate'];`
	`283`	`+ $apiClasses = ['\Codeception\Module', '\Codeception\InitTemplate'];`
`284`	`284`
`285`	`285`	`foreach ($apiClasses as $apiClass) {`
`286`	`286`	`$name = (new ReflectionClass($apiClass))->getShortName();`