Document what "escape" means in tor_escape_str_for_pt_args

diff --git a/src/common/util.c b/src/common/util.c
index eb932f30547db531775e91bf658918405c656a1c..0e8d34eafd3d44ed4dd18f742f57a10e0c7c010d 100644 (file)
--- a/src/common/util.c
+++ b/src/common/util.c
@@ -1223,9 +1223,8 @@ escaped(const char *s)
   return escaped_val_;
 }
 
-/** Escape every character of <b>string</b> that is in
- *  <b>chars_to_escape</b>. The returned string is allocated on the
- *  heap and it's the responsibility of the caller to free it. */
+/** Return a newly allocated string equal to <b>string</b>, except that every
+ * character in <b>chars_to_escape</b> is preceded by a backslash. */
 char *
 tor_escape_str_for_pt_args(const char *string, const char *chars_to_escape)
 {