Skip to content

Commit c2333e6

Browse files
committed
minor symfony#17437 [Finder] Improve the phpdoc of SplFileInfo methods (mnapoli)
This PR was submitted for the master branch but it was merged into the 2.3 branch instead (closes symfony#17437). Discussion ---------- [Finder] Improve the phpdoc of SplFileInfo methods | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - I **always** get confused when I need to use the finder (getFilename, getPath, getPathname, getRelativePath, getRelativePathname, …). This is only addressing the last two methods but hopefully it will help. Commits ------- 1b170d7 Improve the phpdoc of SplFileInfo methods
2 parents b702448 + 1b170d7 commit c2333e6

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/Symfony/Component/Finder/SplFileInfo.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ public function __construct($file, $relativePath, $relativePathname)
3838
/**
3939
* Returns the relative path.
4040
*
41+
* This path does not contain the file name.
42+
*
4143
* @return string the relative path
4244
*/
4345
public function getRelativePath()
@@ -48,6 +50,8 @@ public function getRelativePath()
4850
/**
4951
* Returns the relative path name.
5052
*
53+
* This path contains the file name.
54+
*
5155
* @return string the relative path name
5256
*/
5357
public function getRelativePathname()

0 commit comments

Comments
 (0)