Skip to content

Unified method style#127

Merged
alan-george-lk merged 22 commits into
mainfrom
feature/unified_method_style
May 20, 2026
Merged

Unified method style#127
alan-george-lk merged 22 commits into
mainfrom
feature/unified_method_style

Conversation

@alan-george-lk
Copy link
Copy Markdown
Collaborator

@alan-george-lk alan-george-lk commented May 13, 2026

This PR addresses the following:

  • Through an audit of the current state of the repo, the vast majority of functions/methods were lower camel-case styling (AKA camelBack()). Some were PascalCase and snake_case
  • Moving from this PR forward, all functions/methods should be camelBack() case
    • Public headers: methods that violate this rule are duplicated, old ones kept and marked [[deprecated]], such that we have some time to fix other references (examples) prior to release
    • Internal header symbols were updated outright (no duplication/deprecation needed)
    • Unit tests/docs/etc. updated
  • clang-tidy now enforces this and will fail builds that violate this

Note: the current plan is to drop the old style deprecated methods for 1.0.0 release. This PR doesn't attempt that just yet

This also addresses a regression in participant.h:

  • Previously had set_* methods (plain member variable setters)
  • Conflicted with local_participant.h versions of the same name after method unification
  • Decision: Now those base methods are removed, and room.h is now a friend class and can directly modify those variables. Matches Python SDK equivalent

@alan-george-lk alan-george-lk marked this pull request as ready for review May 15, 2026 21:57
Copy link
Copy Markdown
Collaborator

@stephen-derosa stephen-derosa left a comment

Choose a reason for hiding this comment

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

LGTM!

Comment thread include/livekit/local_participant.h
Comment thread include/livekit/participant.h
Copy link
Copy Markdown
Collaborator

@xianshijing-lk xianshijing-lk left a comment

Choose a reason for hiding this comment

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

lgtm assuming you address the noexcept

@alan-george-lk alan-george-lk merged commit 3bad48c into main May 20, 2026
23 checks passed
@alan-george-lk alan-george-lk deleted the feature/unified_method_style branch May 20, 2026 21:15
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.

3 participants