From 7ef7147d743b1ca1edb6d40b820c79b7527ab941 Mon Sep 17 00:00:00 2001
From: Tucker Evans <tucker@tuckerevans.com>
Date: Wed, 8 Jul 2020 11:21:55 -0400
Subject: Add note on NULL keys

---
 collections/map/map.adoc | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'collections/map/map.adoc')

diff --git a/collections/map/map.adoc b/collections/map/map.adoc
index 27278b8..695f763 100644
--- a/collections/map/map.adoc
+++ b/collections/map/map.adoc
@@ -9,6 +9,9 @@ NOTE: Keys are passed as void pointers and their data is not copied (this
 should be handled by the user), they should not be freed without clearing the
 map.
 
+NOTE: NULL keys are used to distingish a empty map, therefore NULL keys should
+never be used.
+
 NOTE: There is currently no way to distinquish between a failed retrieval
 (pop, index, back, etc.) and returning a NULL value. Keep this in mind if
 you plan on storing NULL values in the vector, there are plans to fix this in
-- 
cgit v1.1

