docs: fix PedroTroller/phpspec documentation

PedroTroller · Oct 29, 2019 · f378406 · f378406
1 parent 2b4e9ff
commit f378406
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1274,7 +1274,11 @@ return $config;
 
 ## PedroTroller/phpspec
 
+Phpspec scenario functions MUST NOT have a return type declaration.
+
+Phpspec scenario functions MUST NOT have a scope.
 
+The methods of the phpspec specification classes MUST BE sorted (let, letGo, its_*, it_*, getMatchers and the rest of the methods)
 
 
 ### Available options

diff --git a/src/PedroTroller/CS/Fixer/PhpspecFixer.php b/src/PedroTroller/CS/Fixer/PhpspecFixer.php
@@ -92,7 +92,14 @@ public function getPriority()
 
     public function getDocumentation()
     {
-        return '';
+        return implode(
+            "\n\n",
+            [
+                'Phpspec scenario functions MUST NOT have a return type declaration.',
+                'Phpspec scenario functions MUST NOT have a scope.',
+                'The methods of the phpspec specification classes MUST BE sorted (let, letGo, its_*, it_*, getMatchers and the rest of the methods)',
+            ]
+        );
     }
 
     /**