8000 Don't use double backquotes in the comments by javiereguiluz · Pull Request #18219 · symfony/symfony-docs · GitHub
[go: up one dir, main page]

Skip to content

Don't use double backquotes in the comments #18219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 4, 2023

Conversation

javiereguiluz
Copy link
Member

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.

@javiereguiluz javiereguiluz added this to the 5.4 milestone Apr 18, 2023
@OskarStark
Copy link
Contributor
OskarStark commented Apr 20, 2023

I think we need to adjust the DOCtor RST rule, this should not be activated in a code-block

cc @MrYamous @alamirault

@xabbuh
Copy link
Member
xabbuh commented Apr 23, 2023

Shouldn't we use double quotes instead of backticks? I personally feel that reading would be easier then.

@javiereguiluz
Copy link
Member Author

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.

@javiereguiluz javiereguiluz merged commit d4e8e64 into symfony:5.4 May 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants
You can’t perform that action at this time.
0