chore: enable automatic trimming of whitespace in Markdown files

kgryte · kgryte · commit baf647c791a0 · 2024-12-16T21:30:02.000-08:00
I tried finding why this was disabled to begin with; however, this
predates the project, and I am not sure the origin. My guess is
that this stems from the Markdown specification allowing two spaces
to force a hard line break. By trimming trailing whitespace, that
could mean that Markdown formatting is affected. However, we do not
use two spaces to force linebreaks. Instead, we use blank lines. As
such, I think we can enable automatic whitespace trimming.
diff --git a/.editorconfig b/.editorconfig
@@ -121,7 +121,7 @@ indent_style = tab
 [*.{md,md.txt}]
 indent_style = space
 indent_size = 4
-trim_trailing_whitespace = false
+trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim.
 
 # Set properties for `usage.txt` files:
 [usage.txt]
