tests: add comment on RawContent test cases

jhillyerd · Nov 9, 2023 · f25733f · f25733f
1 parent 6b26855
commit f25733f
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/encode_test.go b/encode_test.go
@@ -365,6 +365,7 @@ func TestEncodePartContentNonAsciiText(t *testing.T) {
 	}
 }
 
+// TestParseRawContentHTMLOptionTrue tests the RawContent Parser option with an HTML part only if the content isn't changed.
 func TestParseRawContentHTMLOptionTrue(t *testing.T) {
 	r := test.OpenTestData("encode", "parser-raw-content-html-option.raw")
 	p := enmime.NewParser(enmime.RawContent(true))
@@ -379,6 +380,7 @@ func TestParseRawContentHTMLOptionTrue(t *testing.T) {
 	test.DiffGolden(t, b.Bytes(), "testdata", "encode", "parser-raw-content-html-option-true.raw.golden")
 }
 
+// TestParseRawContentHTMLOptionFalse tests without the RawContent Parser option and an HTML part only if the content is normally parsed.
 func TestParseRawContentHTMLOptionFalse(t *testing.T) {
 	r := test.OpenTestData("encode", "parser-raw-content-html-option.raw")
 	p := enmime.NewParser()
@@ -393,6 +395,8 @@ func TestParseRawContentHTMLOptionFalse(t *testing.T) {
 	test.DiffGolden(t, b.Bytes(), "testdata", "encode", "parser-raw-content-html-option-false.raw.golden")
 }
 
+// TestParseRawContentTextOptionTrue tests the RawContent Parser option with a TEXT part only if the content isn't changed.
+// This test uses Japanese characters to also ensure that the charset isn't altered.
 func TestParseRawContentTextOptionTrue(t *testing.T) {
 	r := test.OpenTestData("encode", "parser-raw-content-text-option.raw")
 	p := enmime.NewParser(enmime.RawContent(true))
@@ -407,6 +411,7 @@ func TestParseRawContentTextOptionTrue(t *testing.T) {
 	test.DiffGolden(t, b.Bytes(), "testdata", "encode", "parser-raw-content-text-option-true.raw.golden")
 }
 
+// TestParseRawContentTextOptionFalse tests without the RawContent Parser option and a TEXT part only if the content is normally parsed.
 func TestParseRawContentTextOptionFalse(t *testing.T) {
 	r := test.OpenTestData("encode", "parser-raw-content-text-option.raw")
 	p := enmime.NewParser()