-
Notifications
You must be signed in to change notification settings - Fork 379
Remove TV prefix from Lazy* scrollable components after migration to common foundation #204
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
base: main
Are you sure you want to change the base?
Conversation
Removed TV prefix
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello @UmairKhalid786, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
Hello! Gemini here, providing a summary of this pull request to help everyone get up to speed quickly. This PR aims to update the README.md
file in the JetStreamCompose
module. The core reason for this change is that several Compose components, specifically the Lazy scrollable components like LazyRow
, LazyColumn
, and VerticalGrid
, have been migrated from TV-specific packages to the common androidx.compose.foundation.lazy
package. Consequently, their names no longer require the "Tv" prefix. This pull request updates the documentation to reflect this change, ensuring the README accurately represents the current API structure used in the project's showcases.
Highlights
- Documentation Update: The primary change is an update to the
JetStreamCompose/README.md
file. This update removes the now-redundant "Tv" prefix from the names of Lazy scrollable components (LazyRow
,LazyColumn
,VerticalGrid
) listed in the "Showcases" section, aligning the documentation with the components' migration to the commonandroidx.compose.foundation.lazy
package. - API Alignment: This PR reflects a change in the underlying Compose API structure, where components previously specific to Android TV have been moved to a more general foundation package. Updating the documentation ensures that developers referencing the README are directed to the correct, non-prefixed component names.
Changelog
- JetStreamCompose/README.md
- Updated the "Showcases" list to remove the "Tv" prefix from
TvLazyRow
, changing it toLazyRow
(around line 27). - Updated the "Showcases" list to remove the "Tv" prefix from
TvLazyColumn
, changing it toLazyColumn
(around line 29). - Updated the "Showcases" list to remove the "Tv" prefix from
TvVerticalGrid
, changing it toVerticalGrid
(around line 31).
- Updated the "Showcases" list to remove the "Tv" prefix from
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Docs must stay quite fresh,
When libraries make a change,
Remove the old name.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
Thanks for this update! Aligning the README with the new common foundation component names is a good step for clarity and consistency. The changes for LazyRow
and LazyColumn
look great and accurately reflect the migration.
I have one suggestion regarding VerticalGrid
to ensure maximum clarity and consistency with the other Lazy*
components mentioned.
Summary of Findings
- README Component Naming: The component
TvVerticalGrid
was updated toVerticalGrid
. For better consistency with otherLazy*
components and to accurately reflect the name fromandroidx.compose.foundation.lazy.grid
, it's suggested to useLazyVerticalGrid
.
Merge Readiness
The pull request is a good step towards updating the documentation. There's one medium-severity suggestion to consider for improving the accuracy and consistency of a component name in the README. Addressing this would make the documentation even clearer. I am unable to approve the pull request myself, but I recommend considering this change before merging.
* LazyColumn | ||
* Tv Material Surface | ||
* TvVerticalGrid | ||
* VerticalGrid |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PR aims to reflect the migration to androidx.compose.foundation.lazy
and mentions "Lazy* scrollable components". While VerticalGrid
removes the Tv
prefix, the actual component in androidx.compose.foundation.lazy.grid
is LazyVerticalGrid
.
For consistency with LazyRow
and LazyColumn
in this list, and to more accurately reflect the component name from the foundation library (as seen in FilteredMoviesGrid.kt
and CategoryMovieListScreen.kt
), would it be clearer to use LazyVerticalGrid
here?
* VerticalGrid | |
* LazyVerticalGrid |
This PR updates README to reflect of LazyRow, LazyColumn, and other Lazy* scrollable components by removing the TV-specific prefix. These components have been migrated to the common androidx.compose.foundation.lazy package, so this change aligns the codebase with the latest API structure.