fix: document early hint package dependency #20507
Closed
Conversation
This file contains 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
avoid the internal error at runtime, lets document all requirements directly here, wdyt?
| @@ -778,7 +778,7 @@ but they can be any type of resource. | |||
| .. note:: | |||
|
|
|||
| In order to work, the `SAPI`_ you're using must support this feature, like | |||
| `FrankenPHP`_. | |||
| `FrankenPHP`_ and have symfony/web-link as a dependency. | |||
There was a problem hiding this comment.
I wouldn't add this because the controller.rst file is mainly targeted at newcomers and this feels distracting.
Moreover, if you use the sendEarlyHints() shortcut but don't have web-link installed, you'll see an error message that is probably clear enough for newcomers too:
There was a problem hiding this comment.
indeed I've seen the runtime error as described in the PR, it was just to document more
but I agree, this page is to generic for a doc
perhaps if I see other usage more precise related to http response and assets I will add it there
thank you !
closing meanwhile
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.
avoid the internal error at runtime, lets document all requirements directly here, wdyt?