Write Docstrings for m_tree.py Class

ufosc / manim-data-structures

A Manim plugin that contains common data structures to create Manimations.

https://manim-data-structures.readthedocs.io

MIT License

6 stars 40 forks source link

Open levyjonathan31 opened 8 months ago

levyjonathan31 commented 8 months ago

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
"""

[ ] 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.

tjanderson3 commented 8 months ago

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

levyjonathan31 commented 8 months ago

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!