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.

Sign up for GitHub

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

Jump to bottom

Enhance the implementation of Queue using list #8608

Merged
merged 3 commits into from
Jul 31, 2023
Merged

Enhance the implementation of Queue using list #8608

merged 3 commits into from
Jul 31, 2023

Conversation

amirsoroush
Copy link
Contributor

@amirsoroush amirsoroush commented Apr 2, 2023 •
edited
Loading

Describe your change:

Current implementation has the following problems:

  1. Docstrings are not inside the methods.
  2. There is no type annotation for methods.
  3. self.length is unnecessary as we delegate the operations to the underlying list.
  4. There is no doctest for these methods
  5. No descriptive error message when we .get() from an empty Queue.

I also pushed it with Black formatting applied and checked it with Mypy.

  • Add an algorithm?
  • Fix a bug or typo in 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 include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed enhancement This PR modified some existing files labels Apr 2, 2023
@amirsoroush amirsoroush changed the title enhance the implementation of queue using list Enhance the implementation of Queue using list Apr 2, 2023
tianyizheng02
tianyizheng02 approved these changes Apr 3, 2023
View reviewed changes
Copy link
Contributor

@tianyizheng02 tianyizheng02 left a comment

Choose a reason for hiding this comment

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

Very nice!

@amirsoroush amirsoroush mentioned this pull request Apr 8, 2023
Merged
14 tasks
@tianyizheng02 tianyizheng02 merged commit 384c407 into TheAlgorithms:master Jul 31, 2023
@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Jul 31, 2023
@amirsoroush amirsoroush deleted the queue_on_list_implementation branch July 31, 2023 04:47
sedatguzelsemme pushed a commit to sedatguzelsemme/Python that referenced this pull request Sep 15, 2024
@amirsoroush @sedatguzelsemme
Enhance the implementation of Queue using list (TheAlgorithms#8608)
1697b99 
* enhance the implementation of queue using list

* enhance readability of queue_on_list.py

* rename 'queue_on_list' to 'queue_by_list' to match the class name
@isidroas isidroas mentioned this pull request Jan 25, 2025
Closed
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tianyizheng02 tianyizheng02 tianyizheng02 approved these changes

Assignees
No one assigned
Labels
enhancement This PR modified some existing files
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@amirsoroush @tianyizheng02