Create a script that finds inconsistencies between the input arguments of a function and the docstrings

[jcohenadad]

Context

Currently, the documentation is semi-manually maintained: we need to manually write each input argument so they appear in the documentation.

Problem

• someone adds an argument and forgets to expose it in the docs
• someone removes an argument and forgets to remove it in the docs

Potential solution

A function that would compare the input arguments of each function/class and the exposed arguments in the docstrings, and raise a warning if there is a mismatch. This function would be called by the crawler that goes through all the files/functions of the project.