Add note about in-place editing to g_strdelimit() doc.

	(#118875, Thomas Vander Stichele)

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 6be1a2b..6cf23bb 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+2003-08-05  Matthias Clasen  <maclas@gmx.de>
+
+       * glib/tmpl/string_utils.sgml: Add note about in-place editing to g_strdelimit() doc.
+       (#118875, Thomas Vander Stichele)
+
 2003-07-30  Matthias Clasen  <maclas@gmx.de>
 
        * glib/tmpl/misc_utils.sgml: Move g_getenv() docs inline.

diff --git a/docs/reference/glib/tmpl/string_utils.sgml b/docs/reference/glib/tmpl/string_utils.sgml
index 4a19844..f4ce415 100644 (file)
--- a/docs/reference/glib/tmpl/string_utils.sgml
+++ b/docs/reference/glib/tmpl/string_utils.sgml
@@ -745,7 +745,9 @@ Removes leading and trailing whitespace from a string.
 <para>
 Converts any delimiter characters in @string to @new_delimiter.
 Any characters in @string which are found in @delimiters are changed
-to the @new_delimiter character.
+to the @new_delimiter character. Modifies @string in place, and returns 
+@string itself, not a copy. The return value is to allow nesting such as
+<literal>g_ascii_strup (g_strdelimit (str, "abc", '?'))</literal>.
 </para>
 
 @string: the string to convert.