Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix grammar and wording in documentation #205

Closed
wants to merge 2 commits into from

Conversation

chao2zhang
Copy link
Contributor

@chao2zhang chao2zhang commented Jun 24, 2021

Proposed Changes

  • Grammar fix: Adding a }

Testing

Test: None, since this is documentation

repeatOnLifecycle() makes sense for a cold flow. However, for hot `SharedFlow` and `StateFlow`, they are likely to run on a different coroutineScope such as `viewModelScope`, which is different from the collector's launching lifecycleScope.
Therefore I renamed `uiStateFlow` to `uiDataFlow`, since the former can be easily mistakenly understood as a `StateFlow` for UI.
@google-cla google-cla bot added the cla: yes label Jun 24, 2021
@chao2zhang
Copy link
Contributor Author

Originally I included a renaming:

  • repeatOnLifecycle() makes sense for a cold flow. However, for hot SharedFlowandStateFlow, they are likely to run on a different coroutineScope such as viewModelScope, which is different from the collector's launching lifecycleScope.

On second thought, this is not an issue for SharedFlow or StateFlow with SharingStarted.WhileSubscribed().

@dlam dlam requested a review from jbw0033 July 3, 2021 00:07
jossiwolf pushed a commit to jossiwolf/androidx that referenced this pull request Jul 16, 2021
## Proposed Changes

  - Grammar fix: Adding a `}`

## Testing

Test: None, since this is documentation

This is an imported pull request from androidx#205.

Resolves androidx#205
Github-Pr-Head-Sha: f4ba6b1
GitOrigin-RevId: b9f6400
Change-Id: Iefd9b1d0d8aa7ce7f61b5eb82aae06833ce14d4f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
2 participants