Permalink
Browse files

Info about encodings

  • Loading branch information...
1 parent 9e3624a commit 18e00eccc87b26cc928707ab0f415894cdbc136c @Quintus committed Feb 17, 2012
Showing with 7 additions and 0 deletions.
  1. +7 −0 lib/xz.rb
View
@@ -94,6 +94,13 @@ def clear
#The namespace and main module of this library. Each method of this module
#may raise exceptions of class XZ::LZMAError, which is not named in the
#methods' documentations anymore.
+#
+#All strings you receive from any method defined in this module
+#and the classes defined in it are encoded in BINARY, so you may
+#have to call #force_encoding on them to tag them with the correct
+#encoding (assuming you _know_ what their correct encoding should be).
+#ruby-xz can’t handle this as compiled strings don’t come with encoding
+#information.
module XZ

0 comments on commit 18e00ec

Please sign in to comment.