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

refactor: update device_filter.xml #2640

Open
wants to merge 1 commit into
base: development
Choose a base branch
from
Open

Conversation

td15
Copy link

@td15 td15 commented Mar 6, 2025

Fixes #

Changes

Screenshots / Recordings

Checklist:

  • No hard coding: I have used resources from strings.xml, dimens.xml and colors.xml without hard coding any value.
  • No end of file edits: No modifications done at end of resource files strings.xml, dimens.xml or colors.xml.
  • Code reformatting: I have reformatted code and fixed indentation in every file included in this pull request.
  • No extra space: My code does not contain any extra lines or extra spaces than the ones that are necessary.

Summary by Sourcery

Updates the device_filter.xml file to provide more descriptive comments for each USB device entry, improving readability and maintainability. Also, the comments are reworded to be more consistent.

Copy link

sourcery-ai bot commented Mar 6, 2025

Reviewer's Guide by Sourcery

This pull request enhances the device_filter.xml file by adding descriptive comments for each device section, improving existing comments with more specific information, and removing a duplicate entry. These changes collectively improve the file's readability and maintainability.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added comments to each section to improve readability and maintainability.
  • Added a comment indicating FTDI devices.
  • Added a comment indicating Silicon Labs CP210x devices.
  • Added a comment indicating Prolific PL2303 Series devices.
  • Added a comment indicating Qinheng CH34x USB to Serial Devices.
  • Added a comment indicating CDC (Communication Device Class) Devices.
  • Added a comment indicating Raspberry Pi Pico devices.
app/src/main/res/xml/device_filter.xml
Improved existing comments to provide more clarity and specific device information.
  • Updated FTDI devices comment to include the Vendor ID.
  • Updated Silicon Labs CP210x comment to include the Vendor ID and a more descriptive name.
  • Updated Prolific PL2303 Series comment to include the Vendor ID.
  • Updated Qinheng CH34x USB to Serial Devices comment to include the Vendor ID.
  • Updated ST CDC comment to include the USB IDs.
app/src/main/res/xml/device_filter.xml
Removed a duplicate entry for Qinheng CH9102F.
  • Removed the duplicate line for Qinheng CH9102F.
app/src/main/res/xml/device_filter.xml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @td15 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider grouping the Raspberry Pi Pico entries with a single comment block.
  • It might be helpful to add a comment indicating which devices use the CDC driver.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

github-actions bot commented Mar 6, 2025

@AsCress
Copy link
Collaborator

AsCress commented Mar 7, 2025

@td15 Thank you for your work ! Could you please check the failing CI (Semantic Validation)?

@marcnause marcnause self-requested a review March 30, 2025 15:13
@marcnause marcnause changed the title Update device_filter.xml refactor: update device_filter.xml Apr 2, 2025
@marcnause marcnause added the Status: Review Required Requested reviews from peers and maintainers label Apr 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Review Required Requested reviews from peers and maintainers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants