github-starred/android
2
0
Fork 0
mirror of https://github.com/bitwarden/android.git synced 2026-05-06 07:48:22 -05:00
Code Issues 1.1k Packages Projects Releases 122 Wiki Activity

[PR #6338] [MERGED] Improve KDoc on StateFlowExtensions #32508

New Issue
Closed
opened 2026-04-18 15:53:16 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-18 15:53:16 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/bitwarden/android/pull/6338
Author: @SaintPatrck
Created: 1/8/2026
Status: ✅ Merged
Merged: 1/9/2026
Merged by: @SaintPatrck

Base: main ← Head: update-state-flow-ext-docs

📝 Commits (3)

  • c76fdee Improve KDoc on StateFlowExtensions
  • 125f83c Merge remote-tracking branch 'origin/main' into update-state-flow-ext-docs
  • 6906204 Clarify that the observer callback is invoked with the active user's ID.

📊 Changes

1 file changed (+60 additions, -9 deletions)

View changed files

📝 app/src/main/kotlin/com/x8bit/bitwarden/data/platform/repository/util/StateFlowExtensions.kt (+60 -9)

📄 Description

🎟️ Tracking

Documentation

📔 Objective

Enhance the KDoc for the observeWhenSubscribedAndLoggedIn and observeWhenSubscribedAndUnlocked extension functions.

The objective is to provide clearer, more detailed documentation for developers and LLMs. The new comments explain the lazy invocation behavior, clarify how subscriptionCount is used for detecting external collectors, describe the observer's lifecycle, and include common usage patterns with code examples. This helps prevent misuse and improves understanding of when the expensive operations within the observers will be triggered or canceled.

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/bitwarden/android/pull/6338 **Author:** [@SaintPatrck](https://github.com/SaintPatrck) **Created:** 1/8/2026 **Status:** ✅ Merged **Merged:** 1/9/2026 **Merged by:** [@SaintPatrck](https://github.com/SaintPatrck) **Base:** `main` ← **Head:** `update-state-flow-ext-docs` --- ### 📝 Commits (3) - [`c76fdee`](https://github.com/bitwarden/android/commit/c76fdeeb869b03997c020ff3fa82a68044314f2b) Improve KDoc on StateFlowExtensions - [`125f83c`](https://github.com/bitwarden/android/commit/125f83c5921a0a70270b420b7b04232096add27e) Merge remote-tracking branch 'origin/main' into update-state-flow-ext-docs - [`6906204`](https://github.com/bitwarden/android/commit/69062045b2aeff362b8a561abdca5843e673440e) Clarify that the observer callback is invoked with the active user's ID. ### 📊 Changes **1 file changed** (+60 additions, -9 deletions) <details> <summary>View changed files</summary> 📝 `app/src/main/kotlin/com/x8bit/bitwarden/data/platform/repository/util/StateFlowExtensions.kt` (+60 -9) </details> ### 📄 Description ## 🎟️ Tracking Documentation ## 📔 Objective Enhance the KDoc for the `observeWhenSubscribedAndLoggedIn` and `observeWhenSubscribedAndUnlocked` extension functions. The objective is to provide clearer, more detailed documentation for developers and LLMs. The new comments explain the lazy invocation behavior, clarify how `subscriptionCount` is used for detecting external collectors, describe the observer's lifecycle, and include common usage patterns with code examples. This helps prevent misuse and improves understanding of when the expensive operations within the observers will be triggered or canceled. ## ⏰ Reminders before review - Contributor guidelines followed - All formatters and local linters executed and passed - Written new unit and / or integration tests where applicable - Protected functional changes with optionality (feature flags) - Used internationalization (i18n) for all UI strings - CI builds passed - Communicated to DevOps any deployment requirements - Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team ## 🦮 Reviewer guidelines <!-- Suggested interactions but feel free to use (or not) as you desire! --> - 👍 (`:+1:`) or similar for great changes - 📝 (`:memo:`) or ℹ️ (`:information_source:`) for notes or general info - ❓ (`:question:`) for questions - 🤔 (`:thinking:`) or 💭 (`:thought_balloon:`) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion - 🎨 (`:art:`) for suggestions / improvements - ❌ (`:x:`) or ⚠️ (`:warning:`) for more significant problems or concerns needing attention - 🌱 (`:seedling:`) or ♻️ (`:recycle:`) for future improvements or indications of technical debt - ⛏ (`:pick:`) for minor or nitpick changes --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-18 15:53:16 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
app:authenticator
app:password-manager
bug
bug-passkey
customer-support
duplicate
enhancement
good first issue
help wanted
needs-reply
needs-response
pull-request
Mirrored from GitHub Pull Request
 question
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/android#32508
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?