search

GSTT-CSC / hazen-web-app

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

Decide on Task instructions implementation #15

Closed tomaroberts closed 2 years ago

tomaroberts commented 2 years ago

Currently, the hazenlib tasks are displayed in a form and the docstring associated with the task is displayed alongside the table of tasks:

image

We should redesign this. The current implementation is ugly (mainly because the docstrings are all different). More importantly, once a user is familiar with the hazen-web-app, they will look beyond these instructions and head straight for the buttons which perform the processing.

Lucrezia-Cester commented 2 years ago

Hi all, I think that it is quite important to have a docstring which lets users know what exactly the function does. This is especially important because users might want to know which reference is used to perform a task, ex.: is it from IPEM or is it from a 2022 new paper? On that note, a user (not all users, but someone like Paul) might want a high level description of exactly how the algorithm was implemented. I agree all the docstrings for all the hazenlib functions should be standardized in presentation, but I also think a basic description of algorithm and sources is necessary in all them.

Thoughts?

heyhaleema commented 2 years ago

As discussed in the hackathon, a simple description of the task should be on the web app, with a link to the hazenlib documentation/GitHub for more information on the methods used.