[WIP] Fix code-blocks-checker
#16868
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
OskarStark
reviewed
Jun 12, 2022
| @@ -103,29 +103,29 @@ The ``index()`` method needs the Request object as an argument. | |||
| ``getArguments()`` knows when to inject it properly if it is type-hinted | |||
| correctly:: | |||
|
|
|||
| public function index(Request $request) | |||
| public function index(Request $request) { ... } | |||
There was a problem hiding this comment.
Imho it is too verbose just to make the code checker happy. What about allowing it somehow as is?
There was a problem hiding this comment.
I agree. In the past (when this tool was introduced), we also decided that it's not the goal of documentation examples to be 100% syntax correct. Their goal is to explain the PHP API and do as good of a job as possible on not distracting the user with irrelevant details.
I'm -1 for these additions.
|
If we rerun the CI some errors should be fixed |
|
Jules, I must close this proposal without merging because at least two members of the Docs Team are against this change. I'm sorry, but I thank you for this proposal and for the fixes you did in symfony-tools. Thanks! |
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.
This PR is in sync with symfony-tools/code-block-checker#44.