summaryrefslogtreecommitdiffstats
path: root/common/collection
diff options
context:
space:
mode:
Diffstat (limited to 'common/collection')
-rw-r--r--common/collection/collection.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/common/collection/collection.h b/common/collection/collection.h
index 6868cb6e8..e9533a456 100644
--- a/common/collection/collection.h
+++ b/common/collection/collection.h
@@ -443,6 +443,9 @@ int col_get_item_and_do(struct collection_item *ci, /* A collection of items */
* while the pointer to its data is in use.
* Working with the internals of the collection item structure directly
* may cause problems in future if the internal implementation changes.
+ * The caller needs to be aware that function does not return
+ * error if item is not found. The caller needs to check if
+ * item is not NULL to determine whether something was found.
*/
int col_get_item(struct collection_item *ci, /* Collection to find things in */
const char *property_to_find, /* Name to match */