summaryrefslogtreecommitdiff
path: root/transcode.c
diff options
context:
space:
mode:
authornaruse <naruse@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2009-01-15 13:47:47 +0000
committernaruse <naruse@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2009-01-15 13:47:47 +0000
commit81bdf8a1f2bb3bf46c72191523168ef7dd04983c (patch)
treedd703a381a3b74130964f04804a50c347564356a /transcode.c
parentc1575836273665b5fad8828c45238ce1bee157c7 (diff)
Add rdoc.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@21532 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'transcode.c')
-rw-r--r--transcode.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/transcode.c b/transcode.c
index b2d6706f7e..b01d4a1f08 100644
--- a/transcode.c
+++ b/transcode.c
@@ -2889,7 +2889,7 @@ econv_s_search_convpath(int argc, VALUE *argv, VALUE klass)
}
/*
- * Check the existence of a convertsion path.
+ * Check the existence of a conversion path.
* Returns the number of converters in the conversion path.
* result: >=0:success -1:failure
*/
@@ -3496,6 +3496,10 @@ econv_primitive_convert(int argc, VALUE *argv, VALUE self)
* If a conversion error occur,
* Encoding::UndefinedConversionError or
* Encoding::InvalidByteSequenceError is raised.
+ * Encoding::Converter#convert doesn't supply methods to recover or restart
+ * from these exceptions.
+ * When you want to handle these conversion errors,
+ * use Encoding::Converter#primitive_convert.
*
*/
static VALUE