Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
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:
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