Fix duplicate key.focused condition and refactor to 'when' for clarity#558
Fix duplicate key.focused condition and refactor to 'when' for clarity#558ColtonLeighton wants to merge 2 commits intoscribe-org:mainfrom
Conversation
Thank you for the pull request! 💙The Scribe-Android team will do our best to address your contribution as soon as we can. If you're not already a member of our public Matrix community, please consider joining! We'd suggest that you use the Element client as well as Element X for a mobile app, and definitely join the Note Scribe uses Conventional Comments in reviews to make sure that communication is as clear as possible. |
Maintainer ChecklistThe following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
First PR Commit Check
- The commit messages for the remote branch should be checked to make sure the contributor's email is set up correctly so that they receive credit for their contribution
- The contributor's name and icon in remote commits should be the same as what appears in the PR
- If there's a mismatch, the contributor needs to make sure that the email they use for GitHub matches what they have forgit config user.emailin their local Scribe-Android repo (can be set withgit config --global user.email "GITHUB_EMAIL")
|
Thanks so much for the PR, @ColtonLeighton! Great to have you finding these issues :) Looks like we a inting issue. Could you send along a fix for it? From there we should be able to bring this in quickly 😊 |
| } else { | ||
| mTextColor | ||
| } | ||
| // Set key text color based on state: focused keys are white, pressed keys use a contrasting color, otherwise default text color |
There was a problem hiding this comment.
And can you change this so the comment isn't referring only to light mode, but rather is independent of color mode?
There was a problem hiding this comment.
And ideally end a comment that is its own line with a period so it's a complete sentence :)
| mTextColor | ||
| } | ||
| // Set key text color based on state: focused keys are white, pressed keys use a contrasting color, otherwise default text color | ||
| // Using 'when' makes the logic clearer and avoids evaluating duplicate conditions |
There was a problem hiding this comment.
I think we can remove this comment, but agree that this is nicer :)
|
Post linting fix and the above changes, I think we'll be good to go 😊 |
|
And also check out the testing section of the contributing guide to test your next commit before you send it :) |
2 participants
Contributor checklist
./gradlew lintKotlin detekt testcommand as directed in the testing section of the contributing guideDescription
This pull request fixes a duplicate key.focused check in the text color logic. The original code looked like this:
if (key.focused) {
Color.WHITE
} else if (key.focused) {
mPrimaryColor.getContrastColor()
}
The second key.focused branch could never be reached, because the first if already handles that case. It seems the intention was to check key.pressed instead.
The logic has also been cleaned up using a when statement for readability:
paint.color = when {
key.focused -> Color.WHITE
key.pressed -> mPrimaryColor.getContrastColor()
else -> mTextColor
}
No functional behavior was changed beyond fixing the unreachable condition, but this makes the code clearer and easier to maintain.