SADM/pest
1
0
Fork 0
mirror of https://github.com/pestphp/pest.git synced 2026-03-06 07:47:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

Polishing Up "TestDox.php' PHPDoc Blocks for Clarity

Browse Source 
Added the missing parenthesis and period for proper punctuation and formatted the doc block to meet PHPDocumentor standards.
This commit is contained in:
Sarfaraz Muhammad Sajib
2023-10-16 10:56:06 +06:00
committed by GitHub
parent 502f37d280
commit 9fb64599de
1 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/Factories/Annotations/TestDox.php
View File

@ -14,13 +14,12 @@ final class TestDox implements AddsAnnotations
*/
public function __invoke(TestCaseMethodFactory $method, array $annotations): array
{
/*
* escapes docblock according to
/*
* Escapes docblock according to
* https://manual.phpdoc.org/HTMLframesConverter/default/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#basics.desc
*
* note: '@' escaping is not needed as it cannot be the first character of the line (it always starts with @testdox
* note: '@' escaping is not needed as it cannot be the first character of the line (it always starts with @testdox).
*/
assert($method->description !== null);
$methodDescription = str_replace('*/', '{@*}', $method->description);