search

boxed / p

MIT License
2 stars 1 forks source link

Docstrings of functions #11

Open CSDUMMI opened 5 years ago

CSDUMMI commented 5 years ago

In the last two commit, I added a docstring like this, to everyone of my functions:

"""
<function name>
---------------------
Arguments:
        <arg1> : <Description 1>
        <arg2> : <Description 2>
Returns:
      <Description of return, including type, use and other useful description>

Description:
       <Description of side effects and other important stuff to note, if running this function>
""""

I think we should write such docstrings for every function in p.