-
Notifications
You must be signed in to change notification settings - Fork 91
docs: fix incorrect CommonJS usage heading #1673
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: master
Are you sure you want to change the base?
docs: fix incorrect CommonJS usage heading #1673
Conversation
WalkthroughDocumentation-only change: the README's Usage section header in Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Organization UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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 |
Greptile SummaryFixes the heading in the
Confidence Score: 5/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant U as User
participant R as README.md
participant E as Example File (request-client-js.ts)
U->>R: Reads Usage section
R->>R: Heading: "Usage (ESM / TypeScript)"
R->>E: Links to TypeScript example
E-->>U: Shows ESM import syntax
|
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.
Additional Comments (1)
-
packages/request-client.js/README.md, line 18-20 (link)style: Extra blank line introduced after the heading. Consider removing for consistency.
1 file reviewed, 1 comment
f4074a2 to
09b8be9
Compare
Description of the changes
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.