From 39f36539f619c05f5f668ae289d539a5b0789b8a Mon Sep 17 00:00:00 2001
From: ines <ines@ines.io>
Date: Sat, 20 May 2017 14:32:34 +0200
Subject: [PATCH] Update docstrings and API docs for Matcher

---
 spacy/matcher.pyx             |  4 +++-
 website/docs/api/matcher.jade | 34 ++++++++++++----------------------
 website/docs/usage/v2.jade    |  2 +-
 3 files changed, 16 insertions(+), 24 deletions(-)

diff --git a/spacy/matcher.pyx b/spacy/matcher.pyx
index 87aaa3c50..46a40903b 100644
--- a/spacy/matcher.pyx
+++ b/spacy/matcher.pyx
@@ -199,7 +199,9 @@ cdef class Matcher:
         return (self.__class__, (self.vocab, self._patterns), None, None)
 
     def __len__(self):
-        """Get the number of rules added to the matcher.
+        """Get the number of rules added to the matcher. Note that this only
+        returns the number of rules (identical with the number of IDs), not the
+        number of individual patterns.
 
         RETURNS (int): The number of rules.
         """
diff --git a/website/docs/api/matcher.jade b/website/docs/api/matcher.jade
index 6dae73c51..63c1f9a1e 100644
--- a/website/docs/api/matcher.jade
+++ b/website/docs/api/matcher.jade
@@ -121,15 +121,15 @@ p Match a stream of documents, yielding them in turn.
 +h(2, "len") Matcher.__len__
     +tag method
 
-p Get the number of rules added to the matcher.
+p
+    |  Get the number of rules added to the matcher. Note that this only returns
+    |  the number of rules (identical with the number of IDs), not the number
+    |  of individual patterns.
 
 +aside-code("Example").
-    from spacy.matcher import Matcher
-    from spacy.attrs import ORTH
-
     matcher = Matcher(nlp.vocab)
     assert len(matcher) == 0
-    matcher.add('rule', None, [{ORTH: 'rule'}])
+    matcher.add('Rule', None, [{ORTH: 'test'}])
     assert len(matcher) == 1
 
 +table(["Name", "Type", "Description"])
@@ -144,13 +144,10 @@ p Get the number of rules added to the matcher.
 p Check whether the matcher contains rules for a match ID.
 
 +aside-code("Example").
-    from spacy.matcher import Matcher
-    from spacy.attrs import ORTH
-
     matcher = Matcher(nlp.vocab)
-    assert 'rule' in matcher == False
-    matcher.add('rule', None, [{ORTH: 'rule'}])
-    assert 'rule' in matcher == True
+    assert 'Rule' in matcher == False
+    matcher.add('Rule', None, [{ORTH: 'test'}])
+    assert 'Rule' in matcher == True
 
 +table(["Name", "Type", "Description"])
     +row
@@ -174,9 +171,6 @@ p
     |  overwritten.
 
 +aside-code("Example").
-    from spacy.matcher import Matcher
-    from spacy.attrs import LOWER, ORTH
-
     def on_match(matcher, doc, id, matches):
         print('Matched!', matches)
 
@@ -214,14 +208,10 @@ p
     |  ID does not exist.
 
 +aside-code("Example").
-    from spacy.matcher import Matcher
-    from spacy.attrs import ORTH
-
-    matcher = Matcher(nlp.vocab)
-    matcher.add('rule', None, [{ORTH: 'rule'}])
-    assert 'rule' in matcher == True
-    matcher.remove('rule')
-    assert 'rule' in matcher == False
+    matcher.add('Rule', None, [{ORTH: 'test'}])
+    assert 'Rule' in matcher == True
+    matcher.remove('Rule')
+    assert 'Rule' in matcher == False
 
 +table(["Name", "Type", "Description"])
     +row
diff --git a/website/docs/usage/v2.jade b/website/docs/usage/v2.jade
index 325a4afef..05a90a84e 100644
--- a/website/docs/usage/v2.jade
+++ b/website/docs/usage/v2.jade
@@ -198,7 +198,7 @@ p
 
     +row
         +cell #[code Matcher.has_entity]
-        +cell -
+        +cell #[+api("matcher#contains") #[code Matcher.__contains__]]
 
     +row
         +cell #[code Matcher.get_entity]