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

Improve preview provider name consistency #3673

Merged
merged 2 commits into from
Oct 16, 2024

Conversation

bmarty
Copy link
Member

@bmarty bmarty commented Oct 14, 2024

Content

Rename some classes which implement PreviewParameterProvider according to the new naming convention.

Provider suffix is enough and more used than PreviewProvider, so let's make the codebase more consistent.

Motivation and context

Screenshots / GIFs

Tests

  • There should ne no change in the screenshot nor in the application behavior.

Tested devices

  • Physical
  • Emulator
  • OS version(s):

Checklist

  • Changes have been tested on an Android device or Android emulator with API 23
  • UI change has been tested on both light and dark themes
  • Accessibility has been taken into account. See https://github.com/element-hq/element-x-android/blob/develop/CONTRIBUTING.md#accessibility
  • Pull request is based on the develop branch
  • Pull request title will be used in the release note, it clearly define what will change for the user
  • Pull request includes screenshots or videos if containing UI changes
  • Pull request includes a sign off
  • You've made a self review of your PR

@bmarty bmarty added the PR-Misc For other changes label Oct 14, 2024
@bmarty bmarty requested a review from a team as a code owner October 14, 2024 14:54
@bmarty bmarty requested review from ganfra and removed request for a team October 14, 2024 14:54
Copy link
Contributor

github-actions bot commented Oct 14, 2024

📱 Scan the QR code below to install the build (arm64 only) for this PR.
QR code
If you can't scan the QR code you can install the build via this link: https://i.diawi.com/kvxxz7

Copy link

codecov bot commented Oct 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.79%. Comparing base (d7ca0c1) to head (6e27266).
Report is 9 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #3673      +/-   ##
===========================================
- Coverage    82.80%   82.79%   -0.01%     
===========================================
  Files         1749     1749              
  Lines        41835    41835              
  Branches      5113     5113              
===========================================
- Hits         34640    34639       -1     
  Misses        5380     5380              
- Partials      1815     1816       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@ganfra ganfra left a comment

Choose a reason for hiding this comment

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

I think I'd prefer to use PreviewProvider instead, but as you want.

…end with 'Provider' and MUST contain provided class name`
…g to the new naming convention.

 `Provider` suffix is enough and more used than `PreviewProvider`, so let's make the codebase more consistent.
@bmarty bmarty force-pushed the feature/bma/previewProviderName branch from e561c11 to 6e27266 Compare October 16, 2024 09:18
@bmarty
Copy link
Member Author

bmarty commented Oct 16, 2024

I think I'd prefer to use PreviewProvider instead, but as you want.

Yes, that's probably better but it would require to change much more classes. Also those classes do not provide Preview but States, so naming them ...StateProvider make also some sense... Or the suffix could be PreviewParameterProvider but this is getting long!

Copy link

sonarcloud bot commented Oct 16, 2024

@bmarty bmarty merged commit 9dc58fc into develop Oct 16, 2024
26 checks passed
@bmarty bmarty deleted the feature/bma/previewProviderName branch October 16, 2024 09:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR-Misc For other changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants