docs: add deprecation warning nltk document splitter (#8628)

* adding deprecation warning * adding release notes * adding release notes * updating message * Update haystack/components/preprocessors/nltk_document_splitter.py Co-authored-by: Daria Fokina <[email protected]> --------- Co-authored-by: Daria Fokina <[email protected]>
deepset-ai · Dec 12, 2024 · 6cceaac · 6cceaac
1 parent 04fc187
commit 6cceaac
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/haystack/components/preprocessors/nltk_document_splitter.py b/haystack/components/preprocessors/nltk_document_splitter.py
@@ -2,6 +2,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+import warnings
 from copy import deepcopy
 from typing import Any, Callable, Dict, List, Literal, Optional, Tuple
 
@@ -52,6 +53,13 @@ def __init__(  # pylint: disable=too-many-positional-arguments
             representing the chunks after splitting.
         """
 
+        warnings.warn(
+            "The NLTKDocumentSplitter is deprecated and will be removed in the next release. "
+            "See DocumentSplitter which now supports the functionalities of the NLTKDocumentSplitter, i.e.: "
+            "using NLTK to detect sentence boundaries.",
+            DeprecationWarning,
+        )
+
         super(NLTKDocumentSplitter, self).__init__(
             split_by=split_by,
             split_length=split_length,

diff --git a/releasenotes/notes/deprecating-NLTKDocumentSplitter-e9a621e025e9a49f.yaml b/releasenotes/notes/deprecating-NLTKDocumentSplitter-e9a621e025e9a49f.yaml
@@ -0,0 +1,4 @@
+---
+deprecations:
+  - |
+    The NLTKDocumentSplitter will deprecated and will be removed in the next release. The DocumentSplitter will instead support the functionality of the NLTKDocumentSplitter.