search

ACHMartin / seastar_project

4 stars 0 forks source link

Finish standardisation of docstrings #171

Closed DavidMcCann-NOC closed 1 year ago

DavidMcCann-NOC commented 1 year ago

Need to run Sphinx and/or liaise with Clive to settle on the working docstring format and standardise the language / descriptions used.

Any changes to be retroactively applied to current function docstrings

ACHMartin commented 1 year ago

This need to be done earlier rather than later otherwise we will lose some time to do it again. The documentation might be useful for us as well (for me definitely as I am not very familiar with all functions).

DavidMcCann-NOC commented 1 year ago

Sphinx is now running on my test branch. Still need to fill out docstrings for the remaining functions and tidy them up retroactively before settling on the new (numpy) docstring standard

DavidMcCann-NOC commented 1 year ago

Considered closed with commit #184 - Numpy docstring standard works with Sphinx.