Commenting of functions

[RosCraddock]

Short description for each function in tinypeel and PeelingIO.
Will continue for the other files!

[XingerTang]

@RosCraddock

All the docstrings look good to me! I also did similar work with the src/Peeling.py file, which you can find at here. There are some changes in the code, but they are all made inside the functions. All the input and output variables are the same, so the docstrings are not affected.

One standard format for the docstring is the Sphinx format. If you want to use the format, you can try the VSCode extension autoDocstring and set the "autoDocstring.docstringFormat": "sphinx" setting, under File > Preferences > Settings, to automatically generate templates of docstrings for each function.

One of the advantages of using such a format is that, as our documentation is also generated with Sphinx, we can directly reference the function with its details in our documentation, such as this section.

[gregorgorjanc]

@XingerTang this is a very good suggestion! @RosCraddock can you implement it?

[RosCraddock]

Yes, agreed @gregorgorjanc Should not take long to implement, will update shortly. (:

[RosCraddock]

I have now updated the commenting per @XingerTang's suggestion. I have combined this with my work on integrating phenotype information on a different branch, as I forgot to switch branches. So, I will close this pull request and start another.
@gregorgorjanc, please review and merge the pull request on tinyhouse (AlphaGenes/tinyhouse#25). Then I can update the submodule and create the pull request here on AlphaPeel.