Skip to content

doubly_linked_list.py: Add doctests #2052

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

Closed
wants to merge 4 commits into from

Conversation

cclauss
Copy link
Member

@cclauss cclauss commented May 31, 2020

Describe your change:

  • Add an algorithm?
  • Add tests to an existing algorithm?
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

@cclauss
Copy link
Member Author

cclauss commented May 31, 2020

@WilliamHYZhang @AlexDvorak
Could you please look at why these tests are failing? Am I doing something wrong?

@TheSuperNoob
Copy link
Contributor

Could you please look at why these tests are failing? Am I doing something wrong?

@cclauss
I believe the problem here is with the code, not the tests. line 44: self.head.previous = None
The problem here is that on line 41: self.head = self.head.next will be None, since there is only one element left in the list, head no longer has a next element.

Similarly the problem is also there in deleteTail on line 58 and 59, but this time tail will have no previous element.

@cclauss
Copy link
Member Author

cclauss commented Jun 2, 2020

https://travis-ci.com/github/TheAlgorithms/Python/builds/168928811#L754 is even worse than that. It is saying that self.head is None.

@TheSuperNoob
Copy link
Contributor

https://travis-ci.com/github/TheAlgorithms/Python/builds/168928811#L754 is even worse than that. It is saying that self.head is None.

Yes, because on line 41 self.head is set to self.head.next which would be None in this case, since there is no next node.

@cclauss
Copy link
Member Author

cclauss commented Jun 2, 2020

So, Can you suggest a fix that allows the tests to pass?

@TheSuperNoob
Copy link
Contributor

You can make the tests pass by not trying to use deleteHead or deleteTail on the final element in the list, however I'd recommend fixing the algorithm so this is possible. I can open a PR later today that fixes this.

@stale
Copy link

stale bot commented Jul 2, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale Used to mark an issue or pull request stale. label Jul 2, 2020
@stale
Copy link

stale bot commented Jul 9, 2020

Please reopen this issue once you commit the changes requested or make improvements on the code. Thank you for your contributions.

@stale stale bot closed this Jul 9, 2020
@dhruvmanila dhruvmanila deleted the doubly_linked_list.py-Add-doctests branch October 1, 2022 06:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale Used to mark an issue or pull request stale. tests are failing Do not merge until tests pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants