Skip to content

docs: fix incorrect CommonJS usage heading - #1673

Closed
Olexandr88 wants to merge 1 commit into
RequestNetwork:masterfrom
Olexandr88:docs/fix-commonjs-usage-header
Closed

Olexandr88 wants to merge 1 commit into
RequestNetwork:masterfrom
Olexandr88:docs/fix-commonjs-usage-header

Conversation

@Olexandr88

@Olexandr88 Olexandr88 commented Dec 18, 2025 •

Copy link
Copy Markdown
Contributor

Description of the changes

Summary by CodeRabbit

  • Documentation
    • Clarified the Usage section to indicate ESM and TypeScript support.
    • Minor formatting tweak to the header spacing for readability.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai

coderabbitai Bot commented Dec 18, 2025 •

Copy link
Copy Markdown
Contributor

Walkthrough

Documentation-only change: the README's Usage section header in packages/request-client.js/README.md was renamed from "Usage as commonjs module" to "Usage (ESM / TypeScript)" and a blank line was added after the header.

Changes

Cohort / File(s) Summary
Documentation
packages/request-client.js/README.md
Renamed Usage section header from "Usage as commonjs module" to "Usage (ESM / TypeScript)"; inserted a blank line after the header.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description only contains the template header with no substantive content explaining the changes or their rationale. Replace the template placeholder with a clear explanation of why the heading was incorrect and what the new heading represents.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: fixing the README header from 'CommonJS' to 'ESM / TypeScript', which aligns with the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f4074a2 and 09b8be9.

📒 Files selected for processing (1)
  • packages/request-client.js/README.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/request-client.js/README.md

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@greptile-apps

greptile-apps Bot commented Dec 18, 2025

Copy link
Copy Markdown
Contributor

Greptile Summary

Fixes the heading in the request-client.js README from "Usage as commonjs module" to "Usage (ESM / TypeScript)" to accurately describe the linked example file (request-client-js.ts), which uses ESM import syntax rather than CommonJS require().

  • Corrected misleading heading that described ESM/TypeScript example as CommonJS
  • Minor style issue: an extra blank line was introduced after the heading

Confidence Score: 5/5

  • This PR is safe to merge - it's a documentation-only change with correct content
  • Score reflects minimal risk: single-file documentation change that correctly fixes an inaccurate heading, with only a minor whitespace style issue
  • No files require special attention

Important Files Changed

Filename Overview
packages/request-client.js/README.md Fixed heading from "commonjs module" to "ESM / TypeScript" to correctly describe the linked example file; introduces extra blank line

Sequence Diagram

sequenceDiagram
    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
Loading

@greptile-apps greptile-apps Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Additional Comments (1)

  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

Edit Code Review Agent Settings | Greptile

@MantisClone

Copy link
Copy Markdown
Contributor

Closing as incorrect.

@MantisClone MantisClone closed this Jan 7, 2026
@github-project-automation github-project-automation Bot moved this from 🆕 New to ✅ Done in Request Network Tech Backlog Jan 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

2 participants