Clarify units of string length in decription of scm_from_stringn
authorMark H Weaver <mhw@netris.org>
Thu, 21 Apr 2011 13:56:11 +0000 (09:56 -0400)
committerMark H Weaver <mhw@netris.org>
Thu, 21 Apr 2011 13:56:11 +0000 (09:56 -0400)
* doc/ref/api-data.texi (Conversion to/from C): In description of
  scm_from_stringn, clarify that the length is specified in bytes.

doc/ref/api-data.texi

index 0cae22f..9825bef 100644 (file)
@@ -4293,7 +4293,7 @@ character.
 
 @deftypefn {C Function} SCM scm_from_stringn (const char *str, size_t len, const char *encoding, scm_t_string_failed_conversion_handler handler)
 This function returns a scheme string from the C string @var{str}.  The
-length of the C string is input as @var{len}.  The encoding of the C
+length in bytes of the C string is input as @var{len}.  The encoding of the C
 string is passed as the ASCII, null-terminated C string @code{encoding}.
 The @var{handler} parameters suggests a strategy for dealing with
 unconvertable characters.