Skip to content

Improve clarity in JSON loader documentation (redo) #763

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
Merged
merged 2 commits into from
Oct 7, 2025
Merged

Improve clarity in JSON loader documentation (redo) #763

merged 2 commits into from
Oct 7, 2025

Conversation

anu-rock
Copy link
Contributor

@anu-rock anu-rock commented Oct 7, 2025

Overview

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

  • I have read the contributing guidelines
  • I have tested my changes locally using docs dev
  • 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

@anu-rock
Improve clarity in JSON loader documentation
3d12a28 
- Expand the no JSON pointer example for clarity.
- Correct the output of JSON pointer example.
- Minor copy changes for correctness.
@anu-rock anu-rock requested a review from lnhsingh as a code owner October 7, 2025 03:16
@Copilot Copilot AI review requested due to automatic review settings October 7, 2025 03:16
@anu-rock anu-rock requested a review from katmayb as a code owner October 7, 2025 03:16
Copilot
Copilot AI reviewed Oct 7, 2025
View reviewed changes
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR improves the JSON loader documentation by enhancing clarity and accuracy of examples. The changes focus on making the documentation more comprehensive and correcting outdated output examples.

Key changes:

  • Enhanced the no JSON pointer example with additional nested object data for better clarity
  • Corrected the output format in both examples to match actual loader behavior
  • Minor grammatical improvements for better readability

@github-actions github-actions bot added langchain For docs changes to LangChain oss javascript labels Oct 7, 2025
@anu-rock anu-rock mentioned this pull request Oct 7, 2025
Merged
5 tasks
lnhsingh
lnhsingh approved these changes Oct 7, 2025
View reviewed changes
Copy link
Collaborator

@lnhsingh lnhsingh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@lnhsingh lnhsingh enabled auto-merge (squash) October 7, 2025 19:29
@lnhsingh lnhsingh disabled auto-merge October 7, 2025 19:30
@lnhsingh lnhsingh merged commit bd7eb80 into langchain-ai:main Oct 7, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

@lnhsingh lnhsingh lnhsingh approved these changes

@katmayb katmayb Awaiting requested review from katmayb katmayb is a code owner

Assignees
No one assigned
Labels
javascript langchain For docs changes to LangChain oss
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@anu-rock @lnhsingh