Complete the documentation in the code base

[amtoine]

Addresses issue #56.

In this PR, i have tried to:

• add function signatures where it was missing
• change some of the signatures to make them more coherent across the code base
• rename some functions to make their use clearer and remove their documentation, now not necessary anymore
• add ";" at the end of the lines where i noticed it was missing
• put the main code of ./src/layout.sh in its own main function

The convention for the signatures is quite python-like:

• str and int as the main "types"
• List[{type}] for an unknown number of arguments
• Dict[{key_type}, {value_type}] for an associative array
• [{type}] for an optional type
• ({type_1}, {type_2}) when there are multiple inputs / outputs
• -> to link the inputs and the outputs
• nothing before, resp. after, the -> when there is not input, resp. output, values
• and i've also added, for the functions that are used after a pipe (|), |{piped_type}| to indicate argument comes from a pipe

[amtoine]

These are great remarks :ok_hand:

i'm currently sick and do not feel comfortable to mess with the repo :confused:

count on me to do that as soon as it gets better :wink:

[amtoine]

cool :yum:

i'll merge that then :ok_hand: