[Backport] Fixed type hints and docs for Downloadable Samples block #16825
Conversation
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
|
Hi @ronak2ram. Thank you for your contribution. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Original Pull Request
#16408
Summary
Fixes type hints and PHPDocs in Magento\Downloadable\Block\Catalog\Product\Samples.
Description
In the block class unprecise type hints and PHPDocs are provided. Instead of Magento\Downloadable\Model\ResourceModel\Sample the method getSampleUrl gets an object of type Magento\Downloadable\Model\Sample which actually should be considered as Magento\Downloadable\Api\Data\SampleInterface. Also getSamples doesn't return an array, it returns a Collection.
Fixed Issues
This pull request is not fixing a bug, it just to improve type hints in IDE.