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 5 #36246

Merged
merged 2 commits into from
Oct 8, 2024
Merged

Fix typos and pseudo-typos 5 #36246

merged 2 commits into from
Oct 8, 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 review from a team as code owners October 7, 2024 23:19
@Josh-Cena Josh-Cena requested review from hamishwillee and estelle and removed request for a team October 7, 2024 23:19
@github-actions github-actions bot added Content:HTML Hypertext Markup Language docs Content:HTTP HTTP docs Content:Guide Guide docs Content:Events Events 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 (36 pages)
Flaws (2)

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

URL: /en-US/docs/Web/HTML/Element/track
Title: <track>: The Embed Text Track element
Flaw count: 2

  • macros:
    • /en-US/docs/Web/API/HTMLTrackElement/track does not exist
    • /en-US/docs/Web/API/HTMLTrackElement/track does not exist
External URLs (1)

URL: /en-US/docs/Web/HTML/Element/img
Title: <img>: The Image Embed element

(comment last updated: 2024-10-08 01:11:53)

Copy link
Member

@estelle estelle left a comment

Choose a reason for hiding this comment

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

one question and one nit.

@@ -199,7 +199,7 @@ textarea {
> [!NOTE]
> Placeholders should only be used to show an example of the type of data that should be entered into a form; they are _not_ a substitute for a proper {{HTMLElement("label")}} element tied to the input. See [`<input>` labels](/en-US/docs/Web/HTML/Element/input#labels) for a full explanation.

### Disabled and readonly textareas
### Disabled and readonly text areas
Copy link
Member

Choose a reason for hiding this comment

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

are you sure about this one?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes. HTML has the element textarea because HTML does not use word separators in tag names or attribute names. This does not mean "textarea" is an actual word. We do have many "textarea"s but those are permitted by the spell checker and are hard to enforce, but at least we can enforce "text areas".

files/en-us/web/html/global_attributes/lang/index.md Outdated Show resolved Hide resolved
Co-authored-by: Estelle Weyl <[email protected]>
@@ -319,6 +319,8 @@ The `<audio>` element doesn't directly support WebVTT. You will have to find a l

In addition to spoken dialog, subtitles and transcripts should also identify music and sound effects that communicate important information. This includes emotion and tone. For example, in the WebVTT below, note the use of square brackets to provide tone and emotional insight to the viewer; this can help establish the mood otherwise provided using music, nonverbal sounds and crucial sound effects, and so forth.

<!-- cSpell:ignore switchwatch Swisswatch -->
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we add these words to the ignore-list.txt file instead? We don't have to clutter the content.

@estelle estelle merged commit 783ffd9 into mdn:main Oct 8, 2024
8 checks passed
@Josh-Cena Josh-Cena deleted the typo-5 branch October 8, 2024 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Events Events docs Content:Guide Guide docs Content:HTML Hypertext Markup Language docs Content:HTTP HTTP docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants