Don't use double backquotes in the comments #18219
Merged
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
approved these changes
Apr 18, 2023
|
I think we need to adjust the DOCtor RST rule, this should not be activated in a code-block |
|
Shouldn't we use double quotes instead of backticks? I personally feel that reading would be easier then. |
|
I agree with Christian. After reviewing this, I realized that it's probably better to not add backticks or quotes to some of these items because they can't be mistaken with anything else. I've updated the PR. 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.
I was reading https://symfony.com/doc/current/service_container/autowiring.html and I saw that in some comments, we use double backticks to wrap code elements. I think it looks ugly:
I found other occurrences in other articles, so let's remove all of them.