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

Clarity change: replace "okay" with "not too hard" #37733

Merged
merged 1 commit into from
Jan 21, 2025
Merged

Conversation

mjulmer
Copy link
Contributor

@mjulmer mjulmer commented Jan 21, 2025

In the original sentence, "These are usually okay to fix, as long as you are familiar with the right tools and know what the error messages mean!", readers might understand 'okay' to mean 'allowable'. The sentence reads like "you probably won't cause a problem if you fix this issue" -- when I think it's actually meant to say "these issues probably aren't too difficult to fix".

Description

Motivation

Additional details

Related issues and pull requests

In the original sentence, "These are usually okay to fix, as long as you are familiar with the right tools and know what the error messages mean!", readers might understand 'okay' to mean 'allowable'. The sentence reads like "you probably won't cause a problem if you fix this issue" -- when I think it's actually meant to say "these issues probably aren't too difficult to fix".
@mjulmer mjulmer requested a review from a team as a code owner January 21, 2025 05:46
@mjulmer mjulmer requested review from hamishwillee and removed request for a team January 21, 2025 05:46
@github-actions github-actions bot added the size/xs [PR only] 0-5 LoC changed label Jan 21, 2025
Copy link
Contributor

Preview URLs

Flaws (251)

URL: /en-US/docs/Learn_web_development/Core/Scripting/What_went_wrong
Title: What went wrong? Troubleshooting JavaScript
Flaw count: 251

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/Installing_basic_software
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/What_will_your_website_look_like
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/Dealing_with_files
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/HTML_basics
    • and 246 more flaws omitted

Copy link
Member

@bsmth bsmth left a comment

Choose a reason for hiding this comment

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

Thank you!

@bsmth bsmth merged commit f4c2549 into mdn:main Jan 21, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/xs [PR only] 0-5 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants