From d517dd4297168f244a1686b1b9d96a2e3f2f72fa Mon Sep 17 00:00:00 2001 From: ines Date: Sat, 21 Jul 2018 15:51:28 +0200 Subject: [PATCH] Document remove_extension methods --- website/api/doc.jade | 25 +++++++++++++++++++++++++ website/api/span.jade | 25 +++++++++++++++++++++++++ website/api/token.jade | 25 +++++++++++++++++++++++++ 3 files changed, 75 insertions(+) diff --git a/website/api/doc.jade b/website/api/doc.jade index 8732ae024..c3f152fac 100644 --- a/website/api/doc.jade +++ b/website/api/doc.jade @@ -241,6 +241,31 @@ p Check whether an extension has been registered on the #[code Doc] class. +cell bool +cell Whether the extension has been registered. ++h(2, "remove_extension") Doc.remove_extension + +tag classmethod + +tag-new("2.0.12") + +p Remove a previously registered extension. + ++aside-code("Example"). + from spacy.tokens import Doc + Doc.set_extension('has_city', default=False) + removed = Doc.remove_extension('has_city') + assert not Doc.has_extension('has_city') + ++table(["Name", "Type", "Description"]) + +row + +cell #[code name] + +cell unicode + +cell Name of the extension. + + +row("foot") + +cell returns + +cell tuple + +cell + | A #[code.u-break (default, method, getter, setter)] tuple of the + | removed extension. + +h(2, "char_span") Doc.char_span +tag method +tag-new(2) diff --git a/website/api/span.jade b/website/api/span.jade index c4d49305f..681664269 100644 --- a/website/api/span.jade +++ b/website/api/span.jade @@ -219,6 +219,31 @@ p Check whether an extension has been registered on the #[code Span] class. +cell bool +cell Whether the extension has been registered. ++h(2, "remove_extension") Span.remove_extension + +tag classmethod + +tag-new("2.0.12") + +p Remove a previously registered extension. + ++aside-code("Example"). + from spacy.tokens import Span + Span.set_extension('is_city', default=False) + removed = Span.remove_extension('is_city') + assert not Span.has_extension('is_city') + ++table(["Name", "Type", "Description"]) + +row + +cell #[code name] + +cell unicode + +cell Name of the extension. + + +row("foot") + +cell returns + +cell tuple + +cell + | A #[code.u-break (default, method, getter, setter)] tuple of the + | removed extension. + +h(2, "similarity") Span.similarity +tag method +tag-model("vectors") diff --git a/website/api/token.jade b/website/api/token.jade index 924336481..2152279ec 100644 --- a/website/api/token.jade +++ b/website/api/token.jade @@ -154,6 +154,31 @@ p Check whether an extension has been registered on the #[code Token] class. +cell bool +cell Whether the extension has been registered. ++h(2, "remove_extension") Token.remove_extension + +tag classmethod + +tag-new("2.0.11") + +p Remove a previously registered extension. + ++aside-code("Example"). + from spacy.tokens import Token + Token.set_extension('is_fruit', default=False) + removed = Token.remove_extension('is_fruit') + assert not Token.has_extension('is_fruit') + ++table(["Name", "Type", "Description"]) + +row + +cell #[code name] + +cell unicode + +cell Name of the extension. + + +row("foot") + +cell returns + +cell tuple + +cell + | A #[code.u-break (default, method, getter, setter)] tuple of the + | removed extension. + +h(2, "check_flag") Token.check_flag +tag method