Skip to content

*: fix errors reported by languagetool #6069

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

Merged
merged 31 commits into from
Aug 15, 2021
Merged

Conversation

SethFalco
Copy link
Member

@SethFalco SethFalco commented May 29, 2021

Inspired by: #5848

This only does the English files, LanguageTool does support other languages, but I can't manually review the suggestions.
I dumped only lines starting with > or - from the English files into a single file to save time.

The following is a non-exhaustive list of the changes made to the repository.

Notable Changes

Hyphenated Words or Redundant Spaces

  • human readable -> human-readable
  • Un-select -> Unselect
  • time scale -> timescale
  • user name -> username

Fixed Nouns

  • wifi / WiFi -> Wi-Fi
  • tetris -> Tetris
  • coachdb -> CoachDB
  • heroku -> Heroku
  • monday -> Monday
  • friday -> Friday
  • vue -> Vue

Fixed Acronyms

  • url -> URL
  • uri -> URI
  • usb -> USB
  • instances like pdf, png, jpg, xml, css, html, etc.
  • instances like cpu, ram, etc

Typos

  • pathames -> pathnames
  • parseable -> parsable

Misc Errors

  • its vs it's
  • an vs a
  • singular vs plural
  • double words (ie and and, or the the)
  • inserting the word "the" ie "the largest", or "the highest", etc

Redundancies

These technically aren't incorrect, just longer than it needs to be.

  • all of the -> all the
  • short summary -> summary (short is inferred)
  • in order to -> to

Ignored

The following I ignored on purpose, feel free to drop opinions on them.

British vs American English

I also ignored locale-specific reports like British vs American English as discussed on Matrix. (More Info)

False Positives

It's common to refer to things like npm in lowercase even though it's technically an acronym. This makes LanguageTool mad since it thinks it's an actual word. ie a npm package vs an npm package. It thinks "a npm package" is correct, but because we mean "a NPM package" it should be "an npm package".


I decided to be terrible and fixed another thing on the side in this PR.
There was a command that had extra spaces between arguments, so I also removed that. Nothing to do with LanguageTool.

  • pages/common/acme.sh-dns.md

Copy link
Contributor

@bl-ue bl-ue left a comment

Choose a reason for hiding this comment

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

Wow, this is some really superb work — the most ultimate height of typo-fixing that I could have ever imagined 🚀🚀🚀

@bl-ue
Copy link
Contributor

bl-ue commented May 29, 2021

Here are my opinions regarding your ignored changes (in a nutshell, don't ignore any of them!):

instances like pdf, psd, png, jpg, xml, css, html, etc. Technically, when used on its own it should be uppercase.

I think we should definitely uppercase these.

instances like cpu, ram, gpu, psu, etc. (These should definitely be uppercase.)

Uppercase these too.

all of the -> all the

This has tricked me alot, I think we should use "all the"

short summary -> summary (short is inferred)

Definitely.

in order to -> to

Yep, too wordy is beating around the bush.

@bl-ue bl-ue added mass changes Changes that affect multiple pages. page edit Changes to an existing page(s). labels May 29, 2021
@bl-ue
Copy link
Contributor

bl-ue commented May 29, 2021

@SethFalco maybe also normalize eg.e.g.?

@SethFalco
Copy link
Member Author

I'll stop with the commit spam now. I've applied most of the feedback, and some of the things that I remember skipping before.
Later I'll look at LanguageTool again and see what else it was complaining about.

@bl-ue
Copy link
Contributor

bl-ue commented May 30, 2021

Now why'd you call your branch im-dead 😆

@SethFalco
Copy link
Member Author

Now why'd you call your branch im-dead laughing

Because going through all the problems LanguageTool reported was much more boring than I expected, I wanted to give a subtle clue to my cause of death in case "dying from boredom" could really happen.

SethFalco and others added 25 commits August 15, 2021 18:07
Co-authored-by: CleanMachine1 <78213164+CleanMachine1@users.noreply.github.com>
Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com>
Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com>
Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com>
Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com>
Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com>
Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com>
Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com>
Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com>
Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com>
@SethFalco
Copy link
Member Author

Looks like there's a conflict in pages/common/paci.md

Thanks for the heads-up, should be good to go!

@marchersimon
Copy link
Contributor

Nice, I'll merge

@marchersimon marchersimon merged commit 3e4c519 into tldr-pages:main Aug 15, 2021
@SethFalco SethFalco deleted the im-dead branch July 1, 2024 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
mass changes Changes that affect multiple pages. page edit Changes to an existing page(s).
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants