Suggestion: adopt a documentation format for docstring

As the number of algorithms are increasing, it might make sense to adopt a single documentation format for docstrings. Following are existing currently:

• Google Docstring: https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings
• Numpydoc: https://numpydoc.readthedocs.io/en/latest/format.html
• Sphinx: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html

There are editor extensions which help in generating the docstring based on the chosen format like:

• VSCode: https://github.com/NilsJPWerner/autoDocstring
• Neovim: https://github.com/danymat/neogen

The doctest will come under the examples section for each of the above format.

Commencez par comparer les formats Google Docstring, Numpydoc et Sphinx liés dans l’issue, notamment la manière dont chacun gère les exemples de doctest. Examinez la discussion pour déterminer si le projet a choisi un format. La tâche est considérée comme terminée lorsqu’un format de documentation est convenu et qu’une méthode définie pour l’appliquer aux docstrings des algorithmes existe.