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

Write Docstrings for m_tree.py Class #15

Open
4 tasks
levyjonathan31 opened this issue Jan 25, 2024 · 2 comments
Open
4 tasks

Write Docstrings for m_tree.py Class #15

levyjonathan31 opened this issue Jan 25, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@levyjonathan31
Copy link
Collaborator

levyjonathan31 commented Jan 25, 2024

Description of the proposed feature

Write or update docstrings for each function of the m_tree class using the format below.

"""Summary or Description of the Function

Parameters:

argument1 (int): Description of arg1
Returns:

int: Returning value
"""

TODO

  • Tree
  • update_edges
  • insert_node
  • remove_node

Additional comments

This is currently located on the nary-tree branch. When making changes, create a branch from this branch.

@levyjonathan31 levyjonathan31 added enhancement New feature or request documentation Improvements or additions to documentation good first issue Good for newcomers and removed enhancement New feature or request labels Jan 25, 2024
@tjanderson3
Copy link

Hi Id love to take a look at this issue if you'd still need help with it

@levyjonathan31
Copy link
Collaborator Author

Hi Id love to take a look at this issue if you'd still need help with it

That would be fantastic if you could, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants