content
content copied to clipboard
Fix typos and pseudo-typos 1
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:ignoreto prevent it being ignored in other files.
Preview URLs (54 pages)
/en-US/docs/Games/Techniques/3D_on_the_web/Building_up_a_basic_demo_with_PlayCanvas/editor/en-US/docs/Games/Techniques/Audio_for_Web_Games/en-US/docs/Games/Techniques/Control_mechanisms/Desktop_with_gamepad/en-US/docs/Games/Techniques/Control_mechanisms/Other/en-US/docs/Games/Techniques/Tilemaps/en-US/docs/Games/Tutorials/2D_breakout_game_Phaser/en-US/docs/Glossary/Accessible_name/en-US/docs/Glossary/Entity_header/en-US/docs/Glossary/Falsy/en-US/docs/Glossary/Fetch_metadata_request_header/en-US/docs/Glossary/PHP/en-US/docs/Glossary/Page_load_time/en-US/docs/Glossary/Response_header/en-US/docs/Learn/Accessibility/Multimedia/en-US/docs/Learn/Accessibility/WAI-ARIA_basics/en-US/docs/Learn/CSS/Building_blocks/Backgrounds_and_borders/en-US/docs/Learn/CSS/Building_blocks/Cascade_layers/en-US/docs/Learn/CSS/Building_blocks/Images_tasks/en-US/docs/Learn/CSS/Building_blocks/Organizing/en-US/docs/Learn/CSS/First_steps/How_CSS_is_structured/en-US/docs/Learn/CSS/Styling_text/Web_fonts/en-US/docs/Learn/Common_questions/Tools_and_setup/Upload_files_to_a_web_server/en-US/docs/Learn/Forms/Basic_native_form_controls/en-US/docs/Learn/Forms/How_to_structure_a_web_form/Example/en-US/docs/Learn/Forms/How_to_structure_a_web_form/en-US/docs/Learn/Forms/Styling_web_forms/en-US/docs/Learn/Forms/UI_pseudo-classes/en-US/docs/Learn/Forms/Your_first_form/en-US/docs/Learn/Getting_started_with_the_web/CSS_basics/en-US/docs/Learn/Getting_started_with_the_web/Dealing_with_files/en-US/docs/Learn/Getting_started_with_the_web/How_the_Web_works/en-US/docs/Learn/HTML/Cheatsheet/en-US/docs/Learn/HTML/Introduction_to_HTML/HTML_text_fundamentals/en-US/docs/Learn/HTML/Multimedia_and_embedding/Mozilla_splash_page/en-US/docs/Learn/HTML/Multimedia_and_embedding/Other_embedding_technologies/en-US/docs/Learn/HTML/Multimedia_and_embedding/Video_and_audio_content/Test_your_skills:_Multimedia_and_embedding/en-US/docs/Learn/HTML/Tables/Structuring_planet_data/en-US/docs/Learn/JavaScript/Client-side_web_APIs/Fetching_data/en-US/docs/Learn/JavaScript/First_steps/A_first_splash/en-US/docs/Learn/Learning_and_getting_help/en-US/docs/Learn/Performance/Multimedia/en-US/docs/Learn/Server-side/Django/Deployment/en-US/docs/Learn/Server-side/Django/Forms/en-US/docs/Learn/Server-side/Django/Generic_views/en-US/docs/Learn/Server-side/Django/Models/en-US/docs/Learn/Server-side/Django/Testing/en-US/docs/Learn/Server-side/Express_Nodejs/Introduction/en-US/docs/Learn/Server-side/Express_Nodejs/development_environment/en-US/docs/Learn/Server-side/Express_Nodejs/mongoose/en-US/docs/Learn/Server-side/Express_Nodejs/skeleton_website/en-US/docs/Learn/Server-side/First_steps/Client-Server_overview/en-US/docs/Learn/Server-side/First_steps/Web_frameworks/en-US/docs/Learn/Tools_and_testing/Client-side_JavaScript_frameworks/Svelte_TypeScript/en-US/docs/Learn/Tools_and_testing/Understanding_client-side_tools/Overview
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
- https://en.wikipedia.org/wiki/Isometric_graphics_in_video_games_and_pixel_art (1 time) (Note! This may be a new URL 👀)
URL: /en-US/docs/Games/Techniques/Control_mechanisms/Other
Title: Unconventional controls
- https://cylonjs.com/documentation/drivers/makey-button/ (1 time) (Note! This may be a new URL 👀)
- https://makeymakey.com/ (1 time) (Note! This may be a new URL 👀)
- https://mozilla.github.io/rainbow/ (1 time) (Note! This may be a new URL 👀)
URL: /en-US/docs/Learn/Accessibility/Multimedia
Title: Accessible multimedia
- https://mdn.github.io/learning-area/accessibility/multimedia/audio-transcript-ui/ (1 time) (Note! This may be a new URL 👀)
URL: /en-US/docs/Learn/Getting_started_with_the_web/How_the_Web_works
Title: How the web works
- https://www.pinterest.com/kevindigga/ (1 time) (Note! This may be a new URL 👀)
- https://www.pinterest.com/pin/400538960580676851/ (1 time) (Note! This may be a new URL 👀)
URL: /en-US/docs/Learn/Tools_and_testing/Client-side_JavaScript_frameworks/Svelte_TypeScript
Title: TypeScript support in Svelte
- https://github.com/sveltejs/language-tools/tree/master/packages/svelte-check (1 time) (Note! This may be a new URL 👀)
URL: /en-US/docs/Learn/Tools_and_testing/Understanding_client-side_tools/Overview
Title: Client-side tooling overview
- https://codeclimate.com/ (1 time) (Note! This may be a new URL 👀)
- https://probot.github.io/ (1 time) (Note! This may be a new URL 👀)
- https://updown.io/ (1 time) (Note! This may be a new URL 👀)
- https://webhint.io/docs/user-guide/extensions/extension-browser/ (1 time) (Note! This may be a new URL 👀)
URL: /en-US/docs/Learn/CSS/Styling_text/Web_fonts
Title: Web fonts
- https://everythingfonts.com/ (1 time) (Note! This may be a new URL 👀)
- https://fontforge.org/ (1 time) (Note! This may be a new URL 👀)
- https://www.dafont.com/ (1 time) (Note! This may be a new URL 👀)
- https://www.fontsquirrel.com/ (2 times) (Note! This may be a new URL 👀)
URL: /en-US/docs/Learn/Learning_and_getting_help
Title: Learning and getting help
- https://www.freecodecamp.org/ (1 time) (Note! This may be a new URL 👀)
(comment last updated: 2024-10-24 23:42:01)
@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).
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.
firefoxlogo400.pngvsfirefox-logo400.pngseems 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-overas 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.