search

jonegil / gui-with-gio

Tutorials for Gio, the GUI framework in Go.
https://jonegil.github.io/gui-with-gio/
Other
193 stars 40 forks source link

Linters Gone Wild #15

Closed BuckeyeCoder closed 2 years ago

BuckeyeCoder commented 2 years ago

This PR is a bit different. Let's think about all the kinds of changes that can be made, and then divide them into two groups as follows:

  1. Changes that I wrote; we'll call these "substantive" changes;
  2. Changes coming from the Markdown linter I am using; we'll call those "linter" changes.

With those definitions in place, I will tell you that I wasn't 100% pleased with the last PR. The quality was fine, but it was a challenge for me to see the substantive changes I made because they were swallowed up in all the noise emanating from the linter changes. Instead of the GitHub merging process showing us the small, "surgical strikes" that my edits usually are, it was deleting entire paragraphs and then replacing them simply because it wanted to replace triple back-ticks with single back-ticks.

I would rather have a much quieter merging experience, wouldn't you?

So, that spawned the idea for this PR. This is an entire PR dedicated solely to the Markdown linter! There is not even one substantive change in this entire PR. If its been changed, the linter did it; I am blameless lol.

Now, be assured that I have still code reviewed each linter change here. If its here then I have agreed to it, albeit sometimes with a smirk. You're going to see the following:

  1. Genuine errors being corrected. This includes the code back-tick issue;
  2. The linter being very opinionated, even to the point of being a bit ridiculous.

A common example of the second point is when using italics. There are two perfectly valid forms in Markdown for making a word italic: single asterisks and single underscores. Why there needs to be two I don't know, but there are. For no reason — other than having an opinion — this linter changes asterisks to underscores. Does it hurt anything? No. But it certainly makes for a lot of changes when the author preferred asterisks when writing, thus my smirking.

By giving the linter a chance to get its chattiness over with, future PR's will be much quieter with near 100% substantive changes. This PR is an investment towards a quieter, more studious future. — DW

jonegil commented 2 years ago

Good idea to take all ine one.