Add a memo comment

joaomarques90 · Apr 27, 2019 · 87c80c8 · 87c80c8
1 parent 9eca8c5
commit 87c80c8
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -410,7 +410,7 @@ See `vendor/README` in detail.
 
 The MIT License (MIT)
 
-Copyright (c) 2013, 2014, 2015, 2016, 2017, 2018 Yusuke Endoh (@mametter), @hirekoke
+Copyright (c) 2013, 2014, 2015, 2016, 2017, 2018, 2019 Yusuke Endoh (@mametter), @hirekoke
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

diff --git a/src/README.md.gen.rb b/src/README.md.gen.rb
@@ -196,7 +196,7 @@
 
 The MIT License (MIT)
 
-Copyright (c) 2013, 2014, 2015, 2016, 2017, 2018 Yusuke Endoh (@mametter), @hirekoke
+Copyright (c) 2013, 2014, 2015, 2016, 2017, 2018, 2019 Yusuke Endoh (@mametter), @hirekoke
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

diff --git a/src/code-gen.rb b/src/code-gen.rb
@@ -1430,6 +1430,13 @@ class Scheme_Sed_Shakespeare_SLang < CodeGen
   ]
   Apt = ["guile-2.0", "sed", nil, "slsh"]
   def code
+    # NOTE: This code does not work for a short or simple text.
+    # This assumes the input is so complex enough that
+    # the compressed result won't be one character.
+    #
+    # * The Scheme program generates the encoded Shakespeare code.
+    # * sed program decodes and completes Shakespeare code.
+    # * The S-Lang program includes 8-bit characters and decompress the compression.
     <<-'END'.lines.map {|l| l.strip }.join
       %(
         (display"