Skip to content

Correct the single_peer_connection default in RoomOptions docstring - #917

Merged
GSmithApps merged 1 commit into
mainfrom
docs/single-pc-default
Nov 2, 2026
Merged

GSmithApps merged 1 commit into
mainfrom
docs/single-pc-default

Conversation

@GSmithApps

Copy link
Copy Markdown
Contributor

The docstring said that when None, single_peer_connection defaults to false. In that case the field isn't sent, and the FFI keeps Rust's RoomOptions::default(), which sets it to true (rust-sdks livekit-ffi/src/room_apis/conversion/room.rs, livekit/src/room/mod.rs). Docstring only.

🤖 Generated with Claude Code

When None the field isn't sent, and the FFI keeps the Rust
RoomOptions::default(), which is true.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Nov 2, 2026

Copy link
Copy Markdown
Contributor

👋 This PR has no changeset. If it should be released, add a markdown file under .changeset/ (any name, e.g. .changeset/fix-token-parsing.md):

---
"livekit-rtc": patch
---

Short description of the change, used in the release notes.
  • Packages: livekit-rtc, livekit-api, livekit-protocol (one line per package)
  • Types: patch, minor, major, patch-rc, minor-rc, major-rc, next-rc, promote

If this change doesn't need a release (docs, CI, tests), you can ignore this comment.

@GSmithApps
GSmithApps marked this pull request as ready for review November 2, 2026 21:00

@devin-ai-integration devin-ai-integration 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.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Devin Review

@GSmithApps
GSmithApps merged commit 673480d into main Nov 2, 2026
34 of 49 checks passed
@GSmithApps
GSmithApps deleted the docs/single-pc-default branch November 2, 2026 21:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants