Document function arguments

[paulrougieux]

• Function arguments should be documented whenever possible. The functions in these scripts are not documented:

  • mcda/utils.py
  • mcda/mcda_with_robustness.py please document function arguments and provide examples of how to use them.

• Use a tool such as pdoc or sphynx to generate the documentation automatically from function docstrings. You can create a github workflow that generates the documentation and places it on a github page.

• Functions should be accompanied with an example of how to use them, based on a sample data set. If several function depend on each other, it is fine to group those examples under the main relevant function or object.

Related to the JOSS review openjournals/joss-reviews#6190 .

[Flaminietta]

Dear Paul, I am taking care of this part at #22.