search

GSTT-CSC / hazen-web-app

Interactive web-based implementation of hazen
Other
0 stars 0 forks source link

Desciption of each task is no longer pulled from docstring #76

Closed laurencejackson closed 8 months ago

laurencejackson commented 2 years ago

Previously with the old hazenlib the docstrings were pulled by the webapp to provide an overview of the task. This is no longer happening with the new hazenlib.

e.g. for slice_position

image

sophie22 commented 10 months ago

I'm happy to have a discuss around how we want to communicate to the users what each of the available tasks can do and what sort of input they require. I don't think automatically parsing the doc from the module is the best way to do this.

sophie22 commented 8 months ago

Task description will be described in the ReadTheDocs autogenerated from the hazenlib docstrings and additional descriptions by MR physicists to other users.