Update docstring

gyorilab · Jul 24, 2024 · 4bcb4ea · 4bcb4ea
1 parent 56c0e61
commit 4bcb4ea
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 7 deletions.
diff --git a/gilda/api.py b/gilda/api.py
@@ -120,11 +120,12 @@ def annotate(
     ----------
     text : str
         The text to be annotated.
-    sent_split_fun : Callable, optional
+    sent_split_fun : Callable[str, Iterable[Tuple[int, int]]], optional
         A function that splits the text into sentences. The default is
-        :func:`nltk.tokenize.sent_tokenize`. The function should take a string
-        as input and return an iterable of strings corresponding to the sentences
-        in the input text.
+        :func:`nltk.tokenize.PunktSentenceTokenizer.span_tokenize`. The function
+        should take a string as input and return an iterable of coordinate pairs
+        corresponding to the start and end coordinates for each sentence in the
+        input text.
     organisms : list[str], optional
         A list of organism names to pass to the grounder. If not provided,
         human is used.

diff --git a/gilda/ner.py b/gilda/ner.py
@@ -81,9 +81,10 @@ def annotate(
         The Gilda grounder to use for grounding.
     sent_split_fun : Callable[str, Iterable[Tuple[int, int]]], optional
         A function that splits the text into sentences. The default is
-        :func:`nltk.tokenize.sent_tokenize`. The function should take a string
-        as input and return an iterable of coordinate pairs corresponding to the
-        start and end coordinates for each sentence in the input text.
+        :func:`nltk.tokenize.PunktSentenceTokenizer.span_tokenize`. The function
+        should take a string as input and return an iterable of coordinate pairs
+        corresponding to the start and end coordinates for each sentence in the
+        input text.
     organisms : list[str], optional
         A list of organism names to pass to the grounder. If not provided,
         human is used.