Skip to content

Comments

docs: replace BufferRef mention with BufferSlice#3112

Merged
Brooooooklyn merged 1 commit intonapi-rs:mainfrom
barjin:patch-1
Jan 29, 2026
Merged

docs: replace BufferRef mention with BufferSlice#3112
Brooooooklyn merged 1 commit intonapi-rs:mainfrom
barjin:patch-1

Conversation

@barjin
Copy link
Contributor

@barjin barjin commented Jan 29, 2026 •
edited by coderabbitai bot
Loading

There is no BufferRef symbol in napi-rs. Based on the docstrings, this is likely referring to BufferSlice, which seems to be a non-async alternative for Buffer.

Summary by CodeRabbit

  • Documentation
    • Clarified buffer usage guidance in documentation comments for improved developer reference.

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

@coderabbitai
Copy link

coderabbitai bot commented Jan 29, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

A documentation comment in the BufferSlice struct was updated to correct a reference from BufferRef to BufferSlice in usage guidance, with no functional code changes.

Changes

Cohort / File(s) Summary
Documentation Update
crates/napi/src/bindgen_runtime/js_values/buffer.rs		 Updated documentation comment for BufferSlice non-async usage guidance to reference BufferSlice instead of BufferRef.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

📚 A doc comment danced in the light,
Where BufferRef once stood so bright,
Now BufferSlice takes its place,
With corrected wisdom and grace—
A hop, a fix, all feels quite right! 🐰

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating documentation to replace an incorrect reference (BufferRef) with the correct type (BufferSlice).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings

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.

@Brooooooklyn Brooooooklyn merged commit 2e5588b into napi-rs:main Jan 29, 2026
1 check passed
@github-actions github-actions bot mentioned this pull request Jan 29, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Brooooooklyn Brooooooklyn Brooooooklyn approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@barjin @Brooooooklyn