Skip to content

Commit

Permalink
🐛 add docs for error report if a corpus is not available in system
Browse files Browse the repository at this point in the history
  • Loading branch information
ZenithClown committed Aug 21, 2024
1 parent 779bd97 commit 36ecab0
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions nlpurify/feature/selection/nltk.py
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,9 @@ def tokenize_text(text : str, regexp : bool = False, vanilla : bool = False, **k
:raises ValueError: The error is raised when both the attribute
``vanilla`` and ``regexp`` is set to True.
:raises ImportError: Error is raised when one or more nltk corpus
is not available in the system.
**Return Type**
:rtype: list[str]
Expand Down Expand Up @@ -281,6 +284,9 @@ def remove_stopwords(text : str, language : str = "english", rtype : object = st
not in {str, list} values. Make sure the data type is an type
instance and is not passed as a string value.
:raises ImportError: Error is raised when one or more nltk corpus
is not available in the system.
**Return Type**
:rtype: str | list
Expand Down

0 comments on commit 36ecab0

Please sign in to comment.