Added "See also" #120
Closed
Added "See also" #120
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
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?
TavoNiievez
requested changes
Mar 15, 2021
| * | ||
| * ```php | ||
| * <?php | ||
| * /** @var array<int, \Symfony\Component\Mime\Email> $emails */ |
There was a problem hiding this comment.
Please remove this @var annotation, you can't */ in the middle of a docblock
There was a problem hiding this comment.
But I like the idea - it makes the code sample so nicely copy-pastable :-)
I now tried to escape it - according to https://stackoverflow.com/a/1439351/1668200
Let's see how this comes out - otherwise I'll change it back...
|
@ThomasLandauer please resolve conflicts. |
This was referenced Mar 16, 2021
|
I started from scratch ;-) |
ThomasLandauer
added a commit
to ThomasLandauer/module-symfony
that referenced
this pull request
Mar 16, 2021
`example.com` is the "official" domain for such things: http://example.com/ For the removal, see Codeception#120 (comment)
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.
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
@varannotation 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@varline now breaks the code completely ;-) (same as in #119) - is there a way to escape this?