Fix phpdoc for ResultFile's getContents function - #65
Merged
laurynas-convertapi merged 1 commit intoNov 1, 2024
Merged
Conversation
Contributor
|
Thanks @apple-yagi ! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
The
getContentsmethod of theResultFileclass has a return type specified as string, but the return type of the internally usedfile_get_contentscan befalse|string, which means that thegetContentsmethod's return type is incorrectly annotated. In fact, there have been instances in the service I am developing where it returned false.Therefore, I have updated the PHPDoc to match the return type of
file_get_contents.