about summary refs log tree commit
path: root/README
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2010-09-02 14:27:54 -0700
committerEric Wong <normalperson@yhbt.net>2010-09-02 14:27:54 -0700
commit33eb621b54552e5398752976f07ef9494a610841 (patch)
treece869a8c13a9dd2274f159d499bd05b15653109e /README
parentb758b29f5842d60933d98c1c292f00f73fedf24b (diff)
downloadrpatricia-33eb621b54552e5398752976f07ef9494a610841.tar.gz
sync docs with remove,match_best,match_exact behavior
match_best and match_exact will both return nil instead
of false on failures, matching the documentation.

remove documentation is updated to match the code, which
returns true or false, never nil.
Diffstat (limited to 'README')
-rw-r--r--README2
1 files changed, 1 insertions, 1 deletions
diff --git a/README b/README
index 029599a..3b39e23 100644
--- a/README
+++ b/README
@@ -139,7 +139,7 @@ remove:
     and mask specified from the Patricia Trie.
 
     If the matching node is found in the Patricia Trie, it is removed,
-    and this method returns the true. This method returns nil on
+    and this method returns the true. This method returns false on
     failure.
 
 remove_node:         An alias of remove