GSTT-CSC / hazen

Quality assurance framework for Magnetic Resonance Imaging
https://github.com/GSTT-CSC/hazen
Apache License 2.0
22 stars 12 forks source link

Standardise docstrings #397

Closed sophie22 closed 10 months ago

sophie22 commented 10 months ago

Is your feature request related to a problem? Please describe. Currently each Hazen Task script is written in a slightly different style, both in terms of the level of object oriented abstraction, use of functions and the level of docstrings and in-line comments. In order to be able to generate documentation for the code and make it available to users and future developers (via eg ReadTheDocs) it is required to follow a standardised structure

Describe the solution you'd like Standardise the overall format of task scripts and extend, standardise docstrings for each function within HazenTask scripts.