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

Add even number function and its corresponding unit to main #25

Merged
merged 14 commits into from
Dec 29, 2024
Merged

Conversation

Luyando-Chitindi
Copy link

@Luyando-Chitindi Luyando-Chitindi commented Dec 28, 2024


Name: Checking if an integer is even solution review
code review with a checklist

Challenge chosen by: Luyando Chitindi
Assigned to: Luyando Chitindi
-->

The challenge I chose to solve is checking if an integer is an even number.

Behavior

Files

  • The file name describes the function's behavior
  • There is a module docstring in the function file
  • The test file's name matches the function file name -
    /tests/test_file_name.py
  • There is a module docstring in the tests file

Unit Tests

  • The test class has a helpful name in PascalCase
  • The test class has a docstring
  • Every unit test has
    • A helpful name
    • A clear docstring
    • Only one assertion
    • There is no logic in the unit test
  • All tests pass
  • There are tests for defensive assertions
  • There are tests for boundary cases

Function Docstring

  • The function's behavior is described
  • The function's arguments are described:
    • Type
    • Purpose
    • Other assumptions (eg. if it's a number, what's the expected range?)
  • The return value is described
    • Type
    • Other assumptions are documented
  • The defensive assertions are documented using Raises:
    • Each assumption about an argument is checked with an assertion
    • Each assertion checks for only one assumption about the argument
  • Include 3 or more (passing!) doctests

The Function

  • The function's name describes it's behavior
  • The function's name matches the file name
  • The function has correct type annotations

Strategy

Do's

  • Variable names help to understand the strategy
  • Any comments are clear and describe the strategy
  • Lines of code are spaced to help show different stages of the strategy

Don'ts

  • The function's strategy is not described in the documentation
  • Comments explain the strategy, not the implementation
  • The function does not have more comments than code
    • If it does, consider finding a new strategy or a simpler implementation

Implementation

  • The code passes the formatting checks
  • The code passes all Ruff linting checks
  • The code has no (reasonable) Pylint errors
    • In code review, you can decide when fixing a Pylint error is helpful and
      when it's too restricting.
  • Variables are named with snake_case
  • Variable names are clear and helpful
  • The code follows the strategy as simply as possible
  • The implementation is as simple as possible given the strategy
  • The code includes defensive assertions
  • Defensive assertions include as little logic as possible

@Luyando-Chitindi Luyando-Chitindi self-assigned this Dec 28, 2024
@Luyando-Chitindi Luyando-Chitindi linked an issue Dec 28, 2024 that may be closed by this pull request
@Moealfadil
Copy link

check the py_formatting

@Luyando-Chitindi
Copy link
Author

@Moealfadil thank you so much!
i have managed to fix that.

Copy link

@Moealfadil Moealfadil left a comment

Choose a reason for hiding this comment

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

nicely done!

@Moealfadil Moealfadil merged commit 6ce23f1 into main Dec 29, 2024
10 checks passed
@Moealfadil Moealfadil deleted the is-even branch December 29, 2024 07:43
@Luyando-Chitindi Luyando-Chitindi added documentation Improvements or additions to documentation challenge challenges created and removed documentation Improvements or additions to documentation labels Dec 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
challenge challenges created
Projects
Development

Successfully merging this pull request may close these issues.

IsEven
2 participants