added-comment-on-functions

[tarikuamisganaw]

I have added comments on the functions i did for better understanding

[YeabsiraNigusse]

@tarikuamisganaw your pull request has conflict with the main branch. try to pull the changes from the main branch and resolve the conflict.

[tarikuamisganaw]

i have resolved the confilict and pushed it

[samwondim]

Adding function names as a comment is not necessary as that information is already available on the function it self.

[samwondim]

The comments seem to be too long. I wonder if there were ways you could cut down some of the lengthy ones. maybe try not commenting on functions whose actions are obvious to the point that one can understand what is happening in there only by reading the code.
Also I do not think the description of the type of the parameters and returned values is not important since it is already present in the type definition of the functions.

[tarikuamisganaw]

I added comments on all functions because yeab asked to add comments on all the functions i did and the parameters and return type on the code are just types(kind of too generic),i just thought it needs more description

[YeabsiraNigusse]

The comments seem to be too long. I wonder if there were ways you could cut down some of the lengthy ones. maybe try not commenting on functions whose actions are obvious that one can understand what is happening in there only by reading the code. Also I do not thing the description of the type of the parameter and returned values is not important since it is already present in the type definition of the functions.

I tell them to document it the same way we write docstrings for Python functions. That's why the format looks like this.

[YeabsiraNigusse]

looks nice to me.