Improve clarity in JSON loader documentation #742
Merged
Conversation
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
- Expand the no JSON pointer example for clarity. - Correct the output of JSON pointer example. - Minor copy changes for correctness.
There was a problem hiding this comment.
Pull Request Overview
This PR improves the documentation for the JSON loader by enhancing examples for better clarity and correcting output formats. The changes focus on making the documentation more accurate and comprehensive.
- Enhanced the no JSON pointer example with additional nested text structure
- Corrected the output format in code examples to match actual implementation
- Fixed minor grammatical issues and improved clarity of explanations
lnhsingh
approved these changes
Oct 6, 2025
lnhsingh
added a commit
that referenced
this pull request
Oct 6, 2025
|
@anu-rock Thank you for opening this PR! Sorry, I had to revert the merge-- I realized that it was updating the wrong file. Can you please reopen a PR that targets the file in the |
5 tasks
lnhsingh
added a commit
that referenced
this pull request
Oct 7, 2025
## Overview <!-- Brief description of what documentation is being added/updated --> Re-attempting #742, this time in the src file instead of the built file. - Expand the no JSON pointer example for clarity. - Correct the output of JSON pointer example. - Minor copy changes for correctness. ## Type of change **Type:** Fix typo/bug/link/formatting ## Checklist <!-- Put an 'x' in all boxes that apply --> - [x] I have read the [contributing guidelines](README.md) - [x] I have tested my changes locally using `docs dev` - [x] All code examples have been tested and work correctly - [ ] I have used **root relative** paths for internal links - [ ] I have updated navigation in `src/docs.json` if needed - I have gotten approval from the relevant reviewers - (Internal team members only / optional) I have created a preview deployment using the [Create Preview Branch workflow](https://github.com/langchain-ai/docs/actions/workflows/create-preview-branch.yml) Co-authored-by: Lauren Hirata Singh <lauren@langchain.dev>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Overview
Type of change
Type: Fix typo/bug/link/formatting
Checklist
docs devsrc/docs.jsonif needed