From d176afd32f99615360d1d23e622e187b7c5833f4 Mon Sep 17 00:00:00 2001 From: Paul O'Leary McCann Date: Wed, 8 Jun 2022 23:24:14 +0900 Subject: [PATCH] Add note about multiple patterns (#10826) * Add note about multiple patterns * Move note to the top of method docs * Remove EntityRuler note --- website/docs/api/matcher.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/website/docs/api/matcher.md b/website/docs/api/matcher.md index 6c8cae211..9daa0658d 100644 --- a/website/docs/api/matcher.md +++ b/website/docs/api/matcher.md @@ -113,6 +113,10 @@ string where an integer is expected) or unexpected property names. Find all token sequences matching the supplied patterns on the `Doc` or `Span`. +Note that if a single label has multiple patterns associated with it, the +returned matches don't provide a way to tell which pattern was responsible for +the match. + > #### Example > > ```python @@ -131,7 +135,7 @@ Find all token sequences matching the supplied patterns on the `Doc` or `Span`. | _keyword-only_ | | | `as_spans` 3 | Instead of tuples, return a list of [`Span`](/api/span) objects of the matches, with the `match_id` assigned as the span label. Defaults to `False`. ~~bool~~ | | `allow_missing` 3 | Whether to skip checks for missing annotation for attributes included in patterns. Defaults to `False`. ~~bool~~ | -| `with_alignments` 3.0.6 | Return match alignment information as part of the match tuple as `List[int]` with the same length as the matched span. Each entry denotes the corresponding index of the token pattern. If `as_spans` is set to `True`, this setting is ignored. Defaults to `False`. ~~bool~~ | +| `with_alignments` 3.0.6 | Return match alignment information as part of the match tuple as `List[int]` with the same length as the matched span. Each entry denotes the corresponding index of the token in the pattern. If `as_spans` is set to `True`, this setting is ignored. Defaults to `False`. ~~bool~~ | | **RETURNS** | A list of `(match_id, start, end)` tuples, describing the matches. A match tuple describes a span `doc[start:end`]. The `match_id` is the ID of the added match pattern. If `as_spans` is set to `True`, a list of `Span` objects is returned instead. ~~Union[List[Tuple[int, int, int]], List[Span]]~~ | ## Matcher.\_\_len\_\_ {#len tag="method" new="2"}