-
-
Notifications
You must be signed in to change notification settings - Fork 5.4k
README.md - syntax error in the "Executing JavaScript & Extract..." example #1488
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.
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
base: main
Are you sure you want to change the base?
Conversation
…ta without LLMs" example
WalkthroughDocumentation fix in README.md: corrected the JSON example for JsonCssExtractionStrategy by properly closing the fields array with a closing bracket and moving the final closing brace to the correct position. No code, API, or control-flow changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal). Please share your feedback with us on this Discord post. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
450-453
: Rename variable and avoid potential IndexErrorThe extracted data represents courses, not companies, and indexing element 0 can crash on empty results.
Apply:
- companies = json.loads(result.extracted_content) - print(f"Successfully extracted {len(companies)} companies") - print(json.dumps(companies[0], indent=2)) + courses = json.loads(result.extracted_content) + print(f"Successfully extracted {len(courses)} courses") + if courses: + print(json.dumps(courses[0], indent=2)) + else: + print("No courses extracted")
398-429
: Clarify “JSON” vs Python dict in docsThis example defines a Python dict schema (not a JSON string). Consider adding a one‑liner note to avoid confusion for readers expecting raw JSON.
Example note: “schema is a Python dict passed directly to JsonCssExtractionStrategy; if you have a JSON string, load it first with json.loads(...).”
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
(1 hunks)
🔇 Additional comments (1)
README.md (1)
428-429
: Bracket/brace fix LGTMThe fields array and enclosing object are now properly closed; the snippet parses and runs.
Typo in the "Executing JavaScript & Extract Structured Data without LLMs" example.
Summary by CodeRabbit