New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Add usage examples to DocumentSplitter and TextCleaner docstrings #7736

Closed

julian-risch opened this issue May 24, 2024 · 0 comments · Fixed by #7780

Assignees

Labels

Contributions wanted! P1 type:documentation

Member

julian-risch commented May 24, 2024 •

edited

Loading

The docstring of the DocumentSplitter component and of the TextCleaner component should contain a usage example starting with

```python
from haystack import Document, Pipeline
...

just like all other Haystack components. Currently the usage examples are missing for these two components.

julian-risch added Contributions wanted! type:documentation labels

masci added the P1 label

masci assigned dfokina

dfokina mentioned this issue

docs: add examples to preprocessors #7780

Merged

silvanocerza closed this as completed in #7780

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment