Adding @var annotation for return type #119
Closed
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
... to better emphasize what you'll get back; especially since `@return \Symfony\Component\Mime\Email|null` isn't rendered right, due to Codeception/Codeception#6104 So I added a docblock within the docblock, so to say ;-)
ThomasLandauer added a commit to ThomasLandauer/module-symfony that referenced this pull request Mar 15, 2021
I shortened the example, cause `$emails[0]->getTo()[0];` looks strange ;-) Instead, I added the "See also"-links which (I think) are a good idea in general since the page gets longer and longer, so it's harder to get an overview what functions do exist at all... The `@var` annotation syntax is taken from https://phpstan.org/writing-php-code/phpdoc-types#general-arrays - I'm not 100% sure if this is the right way. The closing `*/` in my new `@var` line might break the page rendering completely ;-) (same as in Codeception#119) - is there a way to escape this?
Closed
Member
| This implicitly and explicitly is a solution for unwanted rendering behavior on the website. Besides, you can't add this annotation because you close the comment block You can change |
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.
... to better emphasize what you'll get back; especially since
@return \Symfony\Component\Mime\Email|nullisn't rendered right, due to Codeception/Codeception#6104So I added a docblock within the docblock, so to say ;-)