Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Remove quotes around code spans 1 #35992

Merged
merged 3 commits into from
Sep 23, 2024
Merged

Remove quotes around code spans 1 #35992

merged 3 commits into from
Sep 23, 2024

Conversation

Josh-Cena
Copy link
Member

Quotes around code spans are almost always coming from the Wiki.

  • They are poorly rendered and don't look good on the website.
  • They are often signs of typos: "foo" instead of "foo"
  • If we are referring to code segments, then foo is already unambiguous and we do not need the "foo" tautology
  • If we are referring to a string constant, then quotes are part of its code representation so we should write "foo" instead of "foo".

@Josh-Cena Josh-Cena requested review from a team as code owners September 22, 2024 07:25
@Josh-Cena Josh-Cena requested review from fred-wang, hamishwillee and wbamberg and removed request for a team September 22, 2024 07:25
@github-actions github-actions bot added Content:Learn Learning area docs Content:Other Any docs not covered by another "Content:" label Content:Learn:Django Learning area Django docs Content:Learn:Express Learning area Express docs Content:MathML MathML docs Content:Glossary Glossary entries Content:Security Security docs Content:Learn:JavaScript Learning area JavaScript docs Content:Meta Content in the meta docs Content:Learn:Forms Learning area Forms docs Content:PWA Progressive Web Apps content labels Sep 22, 2024
@github-actions github-actions bot added the size/m [PR only] 51-500 LoC changed label Sep 22, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 22, 2024 •
edited
Loading

Preview URLs (30 pages)
External URLs (1)

URL: /en-US/docs/Web/OpenSearch
Title: OpenSearch description format

(comment last updated: 2024-09-23 13:56:05)

fred-wang
fred-wang approved these changes Sep 23, 2024
View reviewed changes
Copy link
Contributor

@fred-wang fred-wang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

files/en-us/web/mathml/element/semantics/index.md LGTM

I don't know whether you are removing the period intentionally or not. I'm fine either way.

bsmth
bsmth approved these changes Sep 23, 2024
View reviewed changes
Copy link
Member

@bsmth bsmth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two minor comments for you, otherwise LGTM, thank you!

@Josh-Cena
Copy link
Member Author

I don't know whether you are removing the period intentionally or not. I'm fine either way.

Yes. I believe our guidelines is either "no punctuation for all items" or "period for the last and semicolons for everything before".

@Josh-Cena Josh-Cena merged commit 9df96dc into mdn:main Sep 23, 2024
8 checks passed
@Josh-Cena Josh-Cena deleted the rm-quote-1 branch September 23, 2024 13:57
This was referenced Sep 24, 2024
Merged
Merged
fiji-flo pushed a commit that referenced this pull request Oct 2, 2024
@Josh-Cena @bsmth @fiji-flo
Remove quotes around code spans 1 (#35992)
fdb6195 
* Remove quotes around code spans 1

* Update files/en-us/learn/server-side/first_steps/client-server_overview/index.md

Co-authored-by: Brian Thomas Smith <[email protected]>

* Update files/en-us/web/xslt/element/text/index.md

Co-authored-by: Brian Thomas Smith <[email protected]>

---------

Co-authored-by: Brian Thomas Smith <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bsmth bsmth bsmth approved these changes

@fred-wang fred-wang fred-wang approved these changes

Assignees
No one assigned
Labels
Content:Glossary Glossary entries Content:Learn:Django Learning area Django docs Content:Learn:Express Learning area Express docs Content:Learn:Forms Learning area Forms docs Content:Learn:JavaScript Learning area JavaScript docs Content:Learn Learning area docs Content:MathML MathML docs Content:Meta Content in the meta docs Content:Other Any docs not covered by another "Content:" label Content:PWA Progressive Web Apps content Content:Security Security docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Josh-Cena @fred-wang @bsmth