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

Update comment linting errors on PropertiesModelTests #1891

Merged
merged 1 commit into from
Nov 3, 2023

Conversation

jennantilla
Copy link
Contributor

@jennantilla jennantilla commented Nov 2, 2023

Description

One Line Summary

Update comment linting errors on PropertiesModelTests.

Details

#1884 included a new unit test that was merged before #1882, which accounts for linting errors. This update will allow lint checks on future PRs to pass.

Errors:

  • Replace the block comment with an EOL comment
  • A multiline expression should start on a new line

Motivation

Ensure that GitHub Action checking for linting errors pass in future PRs.

Scope

Only comment formatting in PropertiesModelTests were changed to adhere to Kotlin conventions.

Testing

Unit testing

Reran PropertiesModelTests to ensure unit test still passes.
Reran ./gradlew ktlintCheck to ensure lint check passes.

Manual testing

Built/ran on Android 13 emulator to ensure no issue with example app.

Checklist

Overview

  • I have filled out all REQUIRED sections above
  • PR does one thing
    • If it is hard to explain how any codes changes are related to each other then it most likely needs to be more than one PR
  • Any Public API changes are explained in the PR details and conform to existing APIs

Testing

  • I have included test coverage for these changes, or explained why they are not needed
  • All automated tests pass, or I explained why that is not possible
  • I have personally tested this on my device, or explained why that is not possible

Final pass

  • Code is as readable as possible.
    • Simplify with less code, followed by splitting up code into well named functions and variables, followed by adding comments to the code.
  • I have reviewed this PR myself, ensuring it meets each checklist item
    • WIP (Work In Progress) is ok, but explain what is still in progress and what you would like feedback on. Start the PR title with "WIP" to indicate this.

This change is Reviewable

Errors:
- Replace the block comment with an EOL comment
- A multiline expression should start on a new line
@jennantilla jennantilla merged commit a86c887 into user-model/main Nov 3, 2023
1 of 2 checks passed
@jennantilla jennantilla deleted the fix/PropertiesModelTests_linting branch November 3, 2023 21:51
@jennantilla jennantilla mentioned this pull request Nov 3, 2023
jinliu9508 pushed a commit that referenced this pull request Jan 31, 2024
Update comment linting errors on PropertiesModelTests
jinliu9508 pushed a commit that referenced this pull request Jan 31, 2024
Update comment linting errors on PropertiesModelTests
jinliu9508 pushed a commit that referenced this pull request Feb 6, 2024
Update comment linting errors on PropertiesModelTests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants