Permalink
Browse files

Add a note about what String#u does to the receiver

  • Loading branch information...
1 parent d32f5ad commit bbe15315e7ecefed94422ebc5db7800e5f6aaca6 Nikolai Weibull committed Apr 9, 2013
Showing with 2 additions and 0 deletions.
  1. +2 −0 lib/u-1.0.rb
View
@@ -12,6 +12,8 @@ module U
class String
# @return [U::String] A wrapper around the receiver that provides proper
# Unicode handling of its content
+ # @note The receiver will receive #encode(Encoding::UTF_8)#freeze and you
+ # should thus probably not use the receiver after invoking #u on it.
def u
U::String.new(self)
end

0 comments on commit bbe1531

Please sign in to comment.