docs: clarify notebook instructions - #619
Open
vividvisit wants to merge 1 commit into
Open
vividvisit wants to merge 1 commit into
vividvisit wants to merge 1 commit into
Conversation
Signed-off-by: vividvisit <vividvisit@outlook.com>
Author
|
@jennapederson Could you please take a look when you have a chance? Thanks! |
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.
Problem
Polish instructional prose in three notebooks so setup steps and retrieval explanations read naturally.
Solution
The edits clarify initialization, programmatic configuration, returned results, matching criteria, and prerequisites without changing executable cells.
Type of Change
Test Plan
Describe specific steps for validating this change.
Note
Low Risk
Documentation-only typo and newline fixes with no runtime or API impact.
Overview
Polishes instructional prose in three example notebooks with spelling and formatting fixes only; no executable cells or behavior change.
In
langchain-retrieval-agent.ipynb, corrects the Context API section heading (Receiving),feedback_botdocstring (criteria), and grading prompt text (necessary), and restores a proper trailing newline on the notebook JSON.pinecone-quickstart.ipynbfixes initialize in the client setup step.quick-tour/namespacing.ipynbfixes programmatically in the multitenancy guidance.Reviewed by Cursor Bugbot for commit 0f6ecdd. Bugbot is set up for automated code reviews on this repo. Configure here.