Skip to content

Rename "Client Trust" to "Device Trust" in KDoc - #858

Merged
mwickett merged 1 commit into
mainfrom
mwickett/prot-875-rename-client-trust-to-device-trust
Aug 5, 2026
Merged

Rename "Client Trust" to "Device Trust" in KDoc#858
mwickett merged 1 commit into
mainfrom
mwickett/prot-875-rename-client-trust-to-device-trust

Conversation

@mwickett

@mwickett mwickett commented Aug 4, 2026

Copy link
Copy Markdown
Member

Part of PROT-875.

What

Renames the customer-facing feature name "Client Trust" → "Device Trust" in the four places it appears as prose in this SDK:

File What
SignIn.kt NEEDS_CLIENT_TRUST status KDoc
SignInClientTrustView.kt composable KDoc, its @param factor line, and the ClientTrustWarningMessage KDoc

These surface in IDE quick documentation and generated API docs. "Client" is jargon to less technical readers, and "Device Trust" aligns with Protect's "Device Intelligence" naming. This SDK was flagged as still carrying the old name during review of the docs PR.

API values and identifiers are deliberately unchanged

Per Kyle in the naming thread: "we don't have to change APIs but the way we discuss clients externally should flip to devices."

So the com.clerk.ui.signin.clienttrust package, SignInClientTrustView, ClientTrustWarningMessage, isClientTrust, NEEDS_CLIENT_TRUST, and the needs_client_trust wire value all keep their names — renaming them would break existing custom sign-in flows. The diff is 4 lines and touches no identifier, so detekt-baseline.xml needs no regeneration.

No user-facing string changes

R.string.signing_in_from_new_device already reads "You're signing in from a new device. We're asking for verification to keep your account secure." — it was device-worded from the start, so nothing an end user sees changes here.

Related

Note

Rename 'Client Trust' to 'Device Trust' in KDoc comments

Updates KDoc comments in SignIn and SignInClientTrustView to replace 'client trust' with 'device trust', aligning in-code documentation with the product terminology change described in PROT-875. No runtime behavior is affected.

🖇️ Linked Issues

Partially completes PROT-875, which tracks the full rename of 'Client Trust' to 'Device Trust' across docs and product to better align with 'Device Intelligence' feature naming.

Macroscope summarized 0a9bcd0.

Summary by CodeRabbit

  • Documentation
    • Updated sign-in terminology from “client trust” to “device trust” for clearer device verification messaging.

Renames the customer-facing feature name in the four places it appears as
prose in this SDK: the `NEEDS_CLIENT_TRUST` status KDoc and three KDoc
comments on `SignInClientTrustView` / `ClientTrustWarningMessage`. These
surface in IDE quick documentation and generated API docs.

Identifiers are deliberately unchanged. The `com.clerk.ui.signin.clienttrust`
package, `SignInClientTrustView`, `ClientTrustWarningMessage`,
`isClientTrust`, `NEEDS_CLIENT_TRUST`, and the `needs_client_trust` wire
value all keep their names, since the backing APIs are not being renamed
and renaming them would break existing custom sign-in flows.

The end-user-visible string (`signing_in_from_new_device`) already reads
"You're signing in from a new device...", so no user-facing string changes.

Part of PROT-875.
@coderabbitai

coderabbitai Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The change updates sign-in documentation terminology from “client trust” to “device trust.” Enum values, serialized names, and runtime behavior remain unchanged.

Changes

Device trust terminology

Layer / File(s) Summary
Update sign-in verification documentation
source/api/.../SignIn.kt, source/ui/.../SignInClientTrustView.kt
The NEEDS_CLIENT_TRUST status and client trust view documentation now describe device trust verification.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: swolfand

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly and concisely describes the terminology change made to KDoc comments.
Description check ✅ Passed The description explains the change, rationale, compatibility decisions, affected files, and lack of runtime or user-facing changes.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch mwickett/prot-875-rename-client-trust-to-device-trust

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

@mwickett
mwickett requested review from mikepitre and swolfand August 4, 2026 23:18
@manovotny manovotny self-assigned this Aug 5, 2026

@manovotny manovotny 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.

This LGTM, but hopefully the mobile team can +1 too.

@mwickett
mwickett merged commit a566fb3 into main Aug 5, 2026
11 checks passed
@mwickett
mwickett deleted the mwickett/prot-875-rename-client-trust-to-device-trust branch August 5, 2026 23:25
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