content icon indicating copy to clipboard operation
content copied to clipboard

Fix typos and pseudo-typos 1

Open Josh-Cena opened this issue 1 year ago • 2 comments

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 avatar Oct 07 '24 23:10 Josh-Cena

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)

github-actions[bot] avatar Oct 07 '24 23:10 github-actions[bot]

@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).

Josh-Cena avatar Oct 10 '24 19:10 Josh-Cena

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.

hamishwillee avatar Oct 22 '24 00:10 hamishwillee

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 avatar Oct 22 '24 04:10 Josh-Cena