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.

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

Fix typos and pseudo-typos 10 #36251

Merged
merged 2 commits into from
Oct 27, 2024
Merged

Fix typos and pseudo-typos 10 #36251

merged 2 commits into from
Oct 27, 2024

Conversation

Josh-Cena
Copy link
Member

I am fixing a lot of nits in content. The goal is to make our custom dictionaries as small as possible by eliminating things that could be better recognized as words. This not only helps with automation but helps with human readers too, especially those who may be slow to recognize words.

  • About half of them are code not properly capitalized.
  • There are some real typos.
  • Occasionally I have to refactor the wording a bit.
  • Where we are demonstrating real typos, I use inline cSpell:ignore to prevent it being ignored in other files.

@Josh-Cena Josh-Cena requested a review from a team as a code owner October 7, 2024 23:21
@Josh-Cena Josh-Cena requested review from Elchi3 and removed request for a team October 7, 2024 23:21
@github-actions github-actions bot added Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed labels Oct 7, 2024
Copy link
Contributor

github-actions bot commented Oct 7, 2024

Preview URLs (48 pages)
Flaws (2)

Note! 47 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/MediaStream
Title: MediaStream
Flaw count: 2

  • macros:
    • /en-US/docs/Web/API/MediaStream/active_event does not exist
    • /en-US/docs/Web/API/MediaStream/inactive_event does not exist
External URLs (1)

URL: /en-US/docs/Web/API/IndexedDB_API/Using_IndexedDB
Title: Using IndexedDB

(comment last updated: 2024-10-27 23:51:14)

@@ -58,10 +58,10 @@ const bindGroup = device.createBindGroup({
},
},
],
label: "mybindgroup",
label: "my-bind-group",
Copy link
Collaborator

Choose a reason for hiding this comment

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

FWIW, and probably too late, I much prefer underscores as a word separator.

Copy link
Member Author

Choose a reason for hiding this comment

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

I have no objection to that so at least we can use underscores for WebGPU docs. Frankly, I would have used spaces since these labels are arbitrary anyway.

Copy link
Collaborator

Choose a reason for hiding this comment

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

So yes, for labels, spaces make more sense. For code I prefer camelcase or _

Copy link
Collaborator

Choose a reason for hiding this comment

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

But thanks for the change!

Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

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

This looks reasonable on a scan. I haven't robustly checked for stuff like linked examples etc.

Approving so you can merge when you need to.

@Josh-Cena Josh-Cena merged commit bff3a6a into mdn:main Oct 27, 2024
8 checks passed
@Josh-Cena
Copy link
Member Author

Thanks for your review!

@Josh-Cena Josh-Cena deleted the typo-10 branch October 27, 2024 23:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants