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

fix typos #36525

Merged
merged 1 commit into from
Oct 28, 2024
Merged

fix typos #36525

merged 1 commit into from
Oct 28, 2024

Conversation

OnkarRuikar
Copy link
Contributor

@OnkarRuikar OnkarRuikar requested review from a team as code owners October 28, 2024 01:53
@OnkarRuikar OnkarRuikar requested review from Elchi3 and bsmth and removed request for a team October 28, 2024 01:53
@github-actions github-actions bot added Content:WebAPI Web API docs system [PR only] Infrastructure and configuration for the project size/s [PR only] 6-50 LoC changed labels Oct 28, 2024
@github-actions GitHub Actions
Copy link
Contributor

Preview URLs

Flaws (1)

URL: /en-US/docs/Web/API/Invoker_Commands_API
Title: Invoker Commands API
Flaw count: 1

  • bad_bcd_queries:
    • No BCD data for query: api.HTMLButtonElement.commandForElement

OnkarRuikar
OnkarRuikar commented Oct 28, 2024
View reviewed changes
files/en-us/web/api/invoker_commands_api/index.md
<img id="myimg" src="photo.jpg" alt="[add appropriate alt text here]" />
<button commandfor="my-img" command="--rotate-left">Rotate left</button>
<button commandfor="my-img" command="--rotate-right">Rotate right</button>
<img id="my-img" src="photo.jpg" alt="[add appropriate alt text here]" />
Copy link
Contributor Author

Choose a reason for hiding this comment

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

https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Writing_style_guide/Code_style_guide/HTML#class_and_id_names

Copy link
Collaborator

Choose a reason for hiding this comment

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

FWIW I hate that guideline. What's wrong with snake case. Boo hiss.

Copy link
Contributor Author

@OnkarRuikar OnkarRuikar Oct 28, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Don't hate the messenger :|
We can start a discussion...

Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't hate the messenger. I prefer snake case generally because:

  • There is never a case where you copy in your id into an API and the separator makes it two identifiers separated by a minus sign.
  • Most text editors/IDEs let you select a whole identifier by double click if it is snake case but not if it is -.

I have a preference for a slightly easier life as an author. But perhaps there is a reason why - is preferred by others?

@hamishwillee hamishwillee merged commit fd9a16a into mdn:main Oct 28, 2024
8 checks passed
@OnkarRuikar OnkarRuikar deleted the typos branch October 29, 2024 03:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hamishwillee hamishwillee hamishwillee approved these changes

@Elchi3 Elchi3 Awaiting requested review from Elchi3 Elchi3 is a code owner automatically assigned from mdn/yari-content-web-api

@bsmth bsmth Awaiting requested review from bsmth bsmth is a code owner automatically assigned from mdn/core-yari-content

Assignees
No one assigned
Labels
Content:WebAPI Web API docs size/s [PR only] 6-50 LoC changed system [PR only] Infrastructure and configuration for the project
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Weekly spelling check
2 participants
@OnkarRuikar @hamishwillee