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

test_linked_list.py is solved #50

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

test_linked_list.py is solved #50

wants to merge 1 commit into from

Conversation

MurtazaHakimi
Copy link
Collaborator

The provided code defines a simple implementation of a linked list in Python, which includes basic operations like insertion, deletion, and traversal. The linked list is implemented using two classes, Node and LinkedList. The Node class represents a node in the linked list, containing a data element and a reference to the next node. The LinkedList class provides various methods to manipulate the linked list, such as push_back to add an element at the end, push_front to add an element at the beginning, and methods for removing elements, accessing the front and back elements, and checking if the list is empty. Additionally, there are test cases in the code that use the unittest framework to verify the correctness of the implemented linked list methods. The tests cover scenarios like adding and removing elements, checking sizes, and handling edge cases. The iter, str, and repr methods are implemented to support iteration, string representation, and object representation, respectively.
-->

  • PR's title includes the challenge's name and language
  • PR has short and clear description of the challenge
  • PR has appropriate labels and milestones for easy identification
  • PR it is assigned to the owner
  • reviewers are assigned
  • the PR contributes only one focused change
  • the branch is up to date with main/master
  • the code works when pulled and run locally
  • all conflicts are resolved (if any)
  • 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

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

Python Files

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

Function Docstring

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

Function Implementation

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

Unit Test Suite

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

AnnaShliapkina
AnnaShliapkina previously approved these changes Jan 23, 2024
Copy link
Collaborator

@AnnaShliapkina AnnaShliapkina left a comment

Choose a reason for hiding this comment

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

The README documents the solution's behavior, strategy(ies) and implementation(s) Need to be structured and not clean explanation)
PR's title includes the challenge's name and language (language doesnt exist) There are use cases in code blocks to illustrate the function's behavior(Doesnt have, Need to add)
There is a module docstring(Doesnt have, Need to add) The solution is not is not copied from [djeada]( Code is copied, just was changed variables names, need another solution) Comments explain the strategy (if necessary)(Doesnt have, Need to add)
There are type annotations(Doesnt have, Need to add) The test class has a docstring(Doesnt have, Need to add)
There are tests for defensive assertions(Doesn`t have, Need to add)

@AnnaShliapkina AnnaShliapkina dismissed their stale review January 23, 2024 14:29

Need to add changes in files described above

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants