Add usage example in README file #13820
Conversation
algorithms-keeper
bot
added
documentation
![algorithms-keeper[bot]](https://avatars.githubusercontent.com/in/235834?s=60&v=4){kind=small}
There was a problem hiding this comment.
Click here to look at the relevant links ⬇️
🔗 Relevant Links
Repository:
Python:
Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options
algorithms-keeper actions can be triggered by commenting on this PR:
@algorithms-keeper reviewto trigger the checks for only added pull request files@algorithms-keeper review-allto trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.
| #class node | ||
| class Node: | ||
| """A node in the Splay Tree.""" | ||
| def __init__(self, key, parent=None, left=None, right=None): |
There was a problem hiding this comment.
Please provide return type hint for the function: __init__. If the function does not return a value, please provide the type hint as: def function() -> None:
Please provide type hint for the parameter: key
Please provide type hint for the parameter: parent
Please provide type hint for the parameter: left
Please provide type hint for the parameter: right
| #Spary Tree class | ||
| class SplayTree: | ||
| """A self-adjusting Binary Search Tree.""" | ||
| def __init__(self): |
There was a problem hiding this comment.
Please provide return type hint for the function: __init__. If the function does not return a value, please provide the type hint as: def function() -> None:
|
|
||
| # --- Basic Rotation Operations --- | ||
|
|
||
| def _rotate_left(self, x): |
There was a problem hiding this comment.
Please provide return type hint for the function: _rotate_left. If the function does not return a value, please provide the type hint as: def function() -> None:
As there is no test file in this pull request nor any test function or class in the file data_structures/binary_tree/splay_tree.py, please provide doctest for the function _rotate_left
Please provide type hint for the parameter: x
Please provide descriptive name for the parameter: x
| y.left = x | ||
| x.parent = y | ||
|
|
||
| def _rotate_right(self, x): |
There was a problem hiding this comment.
Please provide return type hint for the function: _rotate_right. If the function does not return a value, please provide the type hint as: def function() -> None:
As there is no test file in this pull request nor any test function or class in the file data_structures/binary_tree/splay_tree.py, please provide doctest for the function _rotate_right
Please provide type hint for the parameter: x
Please provide descriptive name for the parameter: x
|
|
||
| # --- Core Splay Operation --- | ||
|
|
||
| def _splay(self, x): |
There was a problem hiding this comment.
Please provide return type hint for the function: _splay. If the function does not return a value, please provide the type hint as: def function() -> None:
As there is no test file in this pull request nor any test function or class in the file data_structures/binary_tree/splay_tree.py, please provide doctest for the function _splay
Please provide type hint for the parameter: x
Please provide descriptive name for the parameter: x
algorithms-keeper
bot
added
awaiting reviews
yeshuawm999
force-pushed
the
add-usage-example-readme
branch
from
d4980c3 to
a5af161
Compare
algorithms-keeper
bot
removed
the
require type hints
There was a problem hiding this comment.
Click here to look at the relevant links ⬇️
🔗 Relevant Links
Repository:
Python:
Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options
algorithms-keeper actions can be triggered by commenting on this PR:
@algorithms-keeper reviewto trigger the checks for only added pull request files@algorithms-keeper review-allto trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.
|
|
||
| # --- Basic Rotation Operations --- | ||
|
|
||
| def _rotate_left(self, x: Node) -> None: |
There was a problem hiding this comment.
As there is no test file in this pull request nor any test function or class in the file data_structures/binary_tree/splay_tree.py, please provide doctest for the function _rotate_left
Please provide descriptive name for the parameter: x
| y.left = x | ||
| x.parent = y | ||
|
|
||
| def _rotate_right(self, x: Node) -> None: |
There was a problem hiding this comment.
As there is no test file in this pull request nor any test function or class in the file data_structures/binary_tree/splay_tree.py, please provide doctest for the function _rotate_right
Please provide descriptive name for the parameter: x
|
|
||
| # --- Core Splay Operation --- | ||
|
|
||
| def _splay(self, x: Node) -> None: |
There was a problem hiding this comment.
As there is no test file in this pull request nor any test function or class in the file data_structures/binary_tree/splay_tree.py, please provide doctest for the function _splay
Please provide descriptive name for the parameter: x
|
|
||
| # --- Search Method (Uses splay) --- | ||
|
|
||
| def search(self, key: int) -> bool: |
There was a problem hiding this comment.
As there is no test file in this pull request nor any test function or class in the file data_structures/binary_tree/splay_tree.py, please provide doctest for the function search
There was a problem hiding this comment.
Click here to look at the relevant links ⬇️
🔗 Relevant Links
Repository:
Python:
Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options
algorithms-keeper actions can be triggered by commenting on this PR:
@algorithms-keeper reviewto trigger the checks for only added pull request files@algorithms-keeper review-allto trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.
|
|
||
| # --- Basic Rotation Operations --- | ||
|
|
||
| def _rotate_left(self, x: Node) -> None: |
There was a problem hiding this comment.
As there is no test file in this pull request nor any test function or class in the file data_structures/binary_tree/splay_tree.py, please provide doctest for the function _rotate_left
Please provide descriptive name for the parameter: x
| y.left = x | ||
| x.parent = y | ||
|
|
||
| def _rotate_right(self, x: Node) -> None: |
There was a problem hiding this comment.
As there is no test file in this pull request nor any test function or class in the file data_structures/binary_tree/splay_tree.py, please provide doctest for the function _rotate_right
Please provide descriptive name for the parameter: x
|
|
||
| # --- Core Splay Operation --- | ||
|
|
||
| def _splay(self, x: Node) -> None: |
There was a problem hiding this comment.
As there is no test file in this pull request nor any test function or class in the file data_structures/binary_tree/splay_tree.py, please provide doctest for the function _splay
Please provide descriptive name for the parameter: x
|
|
||
| # --- Search Method (Uses splay) --- | ||
|
|
||
| def search(self, key: int) -> bool: |
There was a problem hiding this comment.
As there is no test file in this pull request nor any test function or class in the file data_structures/binary_tree/splay_tree.py, please provide doctest for the function search
yeshuawm999
force-pushed
the
add-usage-example-readme
branch
from
76c11d1 to
1550664
Compare
algorithms-keeper
bot
removed
require descriptive names
1 participant
Describe your change:
Added a new Usage Example section to the bottom of the README file.
This section explains how users can clone the repository, run algorithms locally, use the interactive Python shell, and run doctests.
It helps beginners quickly understand how to execute algorithms from the project.
Fixes #13714
Checklist: