clarify what smartlist_remove promises, since we rely on it.

svn:r3473

diff --git a/src/common/container.c b/src/common/container.c
index b76b94f013c8dd1e2d32184e2f9993570360d5df..4dc0a7ad77df0e31bd559b860f57254a8d4b4178 100644 (file)
--- a/src/common/container.c
+++ b/src/common/container.c
@@ -100,8 +100,9 @@ void smartlist_add_all(smartlist_t *sl, const smartlist_t *s2)
   SMARTLIST_FOREACH(s2, void *, element, smartlist_add(sl, element));
 }
 
-/** Remove all elements E from sl such that E==element.  Does not preserve
- * the order of s1.
+/** Remove all elements E from sl such that E==element.  Preserve
+ * the order of any elements before E, but elements after E can be
+ * rearranged.
  */
 void smartlist_remove(smartlist_t *sl, void *element) {
   int i;