🐛 fix(docs_test.go): add comment to clarify the purpose of normalizin…

…g newlines in test

docs_test.go

@@ -39,7 +39,7 @@ func TestToTabularToFileBetweenTags(t *testing.T) {
 	expectedDocs, fErr := os.ReadFile("testdata/expected-tabular-markdown-full.md")
 	expect(t, fErr, nil) // read without error
 
-	// normalizes \r\n (windows) and \r (mac) into \n (unix)
+	// normalizes \r\n (windows) and \r (mac) into \n (unix) (required for tests to pass on windows)
 	var normalizeNewlines = func(d []byte) []byte {
 		d = bytes.Replace(d, []byte{13, 10}, []byte{10}, -1) // replace CR LF \r\n (windows) with LF \n (unix)
 		d = bytes.Replace(d, []byte{13}, []byte{10}, -1)     // replace CF \r (mac) with LF \n (unix)