Challenge is_palindrome_after_char_deletion, python - Githubissues

MIT-Emerging-Talent / 2024-group-11-collaboration-practice

MIT License

0 stars 3 forks source link

Challenge is_palindrome_after_char_deletion, python #30

Closed MajorPrestige closed 10 months ago

MajorPrestige commented 10 months ago

created function is_palindrome_after_char_deletion connected module with written tests wrote documentation

[x] PR's title includes the challenge's name and language
[x] PR has short and clear description of the challenge
[x] PR has appropriate labels and milestones for easy identification
[x] PR it is assigned to the owner
[x] reviewers are assigned
[ ] the PR contributes only one focused change
[x] the branch is up to date with main/master
[x] the code works when pulled and run locally
[ ] all conflicts are resolved (if any)
[x] It is linked to an issue in the appropriate column of the project board
[ ] feedback is addressed (if any, and if it is appropriate feedback.)

README Documentation

[x] The solution is documented in /src/README.md
[x] The markdown source is formatted
[x] Spelling and grammar is correct in all text
[ ] The markdown looks correct when you preview the file
[ ] All links and images work
[x] The README documents the solution's behavior, strategy(ies) and implementation(s)
[x] There are use cases in code blocks to illustrate the function's behavior

Python Files

[x] There is a module header
[x] There is a module docstring
[x] File names are in snake_case
[x] Test files are named test_<module_name>.py

Function Docstring

[x] Behavior description
[x] Parameter description
[x] Return value description
[ ] Include any assumptions
[x] Include 3 or more (passing!) doctests
[x] Include 1-2 use cases (if necessary)

Function Implementation

[x] The solution is not is not copied from djeada
[x] The code is auto-formatted
[x] The code has no (reasonable) linting mistakes
[x] Variables are named with snake_case
[x] The function has a clear and helpful name
[x] The file's name matches the function name
[x] The code follows the strategy as simply as possible
[x] Variable names are clear and helpful
[x] Comments explain the strategy (if necessary)
[x] There are type annotations
[x] (challenge) The code includes defensive assertions

Unit Test Suite

[x] The test class has a helpful name in PascalCase
[x] The test class has a docstring
Each unit test has
- [ ] A helpful name
- [x] A clear docstring
- [x] Only one assertion
[x] All tests pass
[x] There are tests for defensive assertions
[ ] There are tests for boundary cases
[ ] Test suite includes black-box and glass-box tests