Merge pull request #43 from fhasanaj/RCB-385_deprecate_linked_entities

Changed linked param to resolve_entities

Author: cp2boston

rosette/api.py

@@ -700,19 +700,19 @@ def morphology(self, parameters, facet=MorphologyOutput.COMPLETE):
         @return: A python dictionary containing the results of morphological analysis."""
         return EndpointCaller(self, "morphology/" + facet).call(parameters)
 
-    def entities(self, parameters, linked=False):
+    def entities(self, parameters, resolve_entities=False):
         """
         Create an L{EndpointCaller}  to identify named entities found in the texts
         to which it is applied and call it. Linked entity information is optional, and
         its need must be specified at the time the operator is created.
         @param parameters: An object specifying the data,
         and possible metadata, to be processed by the entity identifier.
         @type parameters: L{DocumentParameters} or L{str}
-        @param linked: Specifies whether or not linked entity information will
+        @param resolve_entities: Specifies whether or not linked entity information will
         be wanted.
-        @type linked: Boolean
+        @type resolve_entities: Boolean
         @return: A python dictionary containing the results of entity extraction."""
-        if linked:
+        if resolve_entities:
             return EndpointCaller(self, "entities/linked").call(parameters)
         else:
             return EndpointCaller(self, "entities").call(parameters)