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 1 #36242

Merged
merged 2 commits into from
Oct 25, 2024
Merged

Fix typos and pseudo-typos 1 #36242

merged 2 commits into from
Oct 25, 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:18
@Josh-Cena Josh-Cena requested review from hamishwillee, chrisdavidmills and scottaohara and removed request for a team October 7, 2024 23:18
@github-actions github-actions bot added Content:Learn Learning area docs Content:Learn:Django Learning area Django docs Content:Learn:Express Learning area Express docs Content:Glossary Glossary entries Content:Games Games docs Content:Learn:Client-side Content under “Client-side JavaScript frameworks” (Svelte, React, Angular, Vue) and related subtrees Content:Learn:JavaScript Learning area JavaScript docs Content:Learn:CSS Learning area CSS docs Content:Learn:HTML Learning area HTML docs Content:Learn:Accessibility Accessibility documentation in the Learn Area Content:Learn:Forms Learning area Forms 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 (54 pages)
Flaws (1)

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

URL: /en-US/docs/Learn/Learning_and_getting_help
Title: Learning and getting help
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/play
External URLs (17)

URL: /en-US/docs/Games/Techniques/Tilemaps
Title: Tiles and tilemaps overview


URL: /en-US/docs/Games/Techniques/Control_mechanisms/Other
Title: Unconventional controls


URL: /en-US/docs/Learn/Accessibility/Multimedia
Title: Accessible multimedia


URL: /en-US/docs/Learn/Getting_started_with_the_web/How_the_Web_works
Title: How the web works


URL: /en-US/docs/Learn/Tools_and_testing/Client-side_JavaScript_frameworks/Svelte_TypeScript
Title: TypeScript support in Svelte


URL: /en-US/docs/Learn/Tools_and_testing/Understanding_client-side_tools/Overview
Title: Client-side tooling overview


URL: /en-US/docs/Learn/CSS/Styling_text/Web_fonts
Title: Web fonts


URL: /en-US/docs/Learn/Learning_and_getting_help
Title: Learning and getting help

(comment last updated: 2024-10-24 23:42:01)

Copy link
Contributor

@chrisdavidmills chrisdavidmills left a comment

Choose a reason for hiding this comment

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

@Josh-Cena I've looked through these fixes and they look OK, but I do have one overriding concern — there may be external examples (e.g. in dom-examples or django-library-tutorial) that this could cause to go out of sync with their associated guides.

Do you intend to update those too, or would it be better to leave such examples (where you are marginally improving class or variable names, for example), alone, to avoid the hassle?

@Josh-Cena
Copy link
Member Author

@chrisdavidmills It would be great if the example repos can be updated too. I don't know if I have time to do that, though. Usually in this sort of batch content update, example repos often lag behind, and that wouldn't be a reason to hold back content updates, because we have well-established linting infrastructure for content but not for example repos (we totally should).

@hamishwillee
Copy link
Collaborator

What is the value of fixing the pseudo typos? firefoxlogo400.png vs firefox-logo400.png seems a pointless fix. If you're a reader you won't care, and as an author I will find it more annoying because selection via double click selects less of the filename.

Ditto things like "game-over" vs "gameover" - I might use game_over, or gameOver for a state name, but I would never use game-over as it might be tokenised to a minus sign.

All the actual typo fixes look great though.

@Josh-Cena
Copy link
Member Author

firefoxlogo400.png vs firefox-logo400.png seems a pointless fix. If you're a reader you won't care, and as an author I will find it more annoying because selection via double click selects less of the filename.

As a reader, a well-separated name is slightly easier to scan. If ease of selection is a showstopper for you, I'm happy to change it to an underscore. From a maintenance perspective, using valid words eliminates the chance of false-negative spell checking elsewhere since we don't have to exempt "firefoxlogo".

Ditto things like "game-over" vs "gameover" - I might use game_over, or gameOver for a state name, but I would never use game-over as it might be tokenised to a minus sign.

Here it's not a code entity though. I could be wrong but I searched everywhere and there's no reference to gameover in code, so I assume it's meant to be plain-English description of the code state, in which case we would either say "game-over" or "game over", and I chose the former because it looks slightly more correct when modifying a noun.

@Josh-Cena Josh-Cena mentioned this pull request Oct 22, 2024
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.

Thanks @Josh-Cena - you've clearly been very careful. Appreciated.

@hamishwillee hamishwillee merged commit baac7f2 into mdn:main Oct 25, 2024
8 checks passed
@Josh-Cena Josh-Cena deleted the typos-1 branch October 25, 2024 01:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Games Games docs Content:Glossary Glossary entries Content:Learn:Accessibility Accessibility documentation in the Learn Area Content:Learn:Client-side Content under “Client-side JavaScript frameworks” (Svelte, React, Angular, Vue) and related subtrees Content:Learn:CSS Learning area CSS docs Content:Learn:Django Learning area Django docs Content:Learn:Express Learning area Express docs Content:Learn:Forms Learning area Forms docs Content:Learn:HTML Learning area HTML docs Content:Learn:JavaScript Learning area JavaScript docs Content:Learn Learning area docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants