Document the assumptions in translate-nl test

Raku · Aug 8, 2018 · 67d6f94 · 67d6f94
1 parent d422889
commit 67d6f94
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/S32-str/encode.t b/S32-str/encode.t
@@ -15,6 +15,10 @@ is "a\nb".encode('utf8').elems, 3, 'right length of Buf with \n';
 if $*DISTRO.is-win {
     is-deeply "a\nb".encode('utf8', :translate-nl), utf8.new(97,0x0d,0x0a,98), 'Translation of \n in Windows environment';
 } else {
+    # Note: this test assumes all OSes it will run on use U+000A as newlines.
+    # Should in the future an OS that uses different line endings be
+    # supported by the language, this test should be modified to look
+    # for that OS's native line endings in the string.
     is-deeply "a\nb".encode('utf8', :translate-nl), utf8.new(97,0x0a,98), 'Non-translation of \n outside Windows';
 }