docs: add PythonCodeSplitter documentation page and register in index#11437
Open
AbdullahUsama wants to merge 2 commits into
Open
docs: add PythonCodeSplitter documentation page and register in index#11437AbdullahUsama wants to merge 2 commits into
AbdullahUsama wants to merge 2 commits into
Conversation
AbdullahUsama
requested review from
Copilot and
sjrl
and removed request for
a team
|
@AbdullahUsama is attempting to deploy a commit to the deepset Team on Vercel. A member of the Team first needs to authorize it. |
|
|
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds documentation for the new PythonCodeSplitter preprocessor and links it from the main PreProcessors documentation index.
Changes:
- Added a new docs page describing
PythonCodeSplitter, including behavior details, metadata, parameters, and usage examples. - Added
PythonCodeSplitterto the PreProcessors component list.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs-website/docs/pipeline-components/preprocessors/pythoncodesplitter.mdx | New component documentation page for PythonCodeSplitter (overview, metadata, parameters, examples). |
| docs-website/docs/pipeline-components/preprocessors.mdx | Adds PythonCodeSplitter entry to the preprocessor list/table. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+94
to
+99
| splitter = PythonCodeSplitter( | ||
| min_effective_lines=20, | ||
| max_effective_lines=100, | ||
| strip_docstrings=True, | ||
| ) | ||
| result = splitter.run(documents=[Document(content=source, meta={"file_name": "my_module.py"})]) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issues
Proposed Changes:
pythoncodesplitter.mdx) for the newly introducedPythonCodeSplittercomponent underdocs-website/docs/pipeline-components/preprocessors/.preprocessors.mdx).How did you test it?
npm run startinside thedocs-websitedirectory. Verified that thePythonCodeSplitterpage renders correctly, the code block formatting is intact, and the link from the category index navigates to the page seamlessly without any build or runtime compilation errors.Notes for the reviewer
The new
.mdxpage closely mirrors the design structure of existing preprocessor component docs (likeDocumentSplitter) to maintain consistency across the Haystack documentation ecosystem.Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:and added!in case the PR includes breaking changes.