GSTT-CSC / hazen-web-app

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

docstring added to task #103

Closed Lucrezia-Cester closed 7 months ago

tomaroberts commented 1 year ago

@Lucrezia-Cester

Can you describe this PR a bit more for me please? And add a screenshot showing the change.

Also, you have committed your Python virtual environment with this PR – please can you remove it.

Lucrezia-Cester commented 1 year ago

Hi @tomaroberts , this PR is linked to an issue (see development issue) and I just solved the issue that was described

Screenshot 2023-02-21 at 08 18 17

I will add a few words in the description and attach a screenshot soon

Lucrezia-Cester commented 1 year ago

Database needs to be migrated to add the new column for task docstring

Lucrezia-Cester commented 1 year ago

hi @hshuaib90, could you please take a look at this PR? I have added a column to the Task table to store docstring data.

When I try to use alembic to generate a migration I get this error

lce21@medphys026-mac hazen-web-app % alembic revision --autogenerate -m "Add docstring column to task table"

FAILED: No config file 'alembic.ini' found, or file has no '[alembic]' section

edit: when running from within the migration folder there is still errors. There is still a problem of running alembic outside the application. error: Working outside of application context.

EDIT2: migration worked. There were inconsistencies with previous migrations which had to be fixed. NO FURTHER HELP NEEDED HERE.

Lucrezia-Cester commented 1 year ago

@hshuaib90, @heyhaleema , this is now ready for review, docstring is added to database in task table if the docstring is present in the original hazenlib task.

https://user-images.githubusercontent.com/83493021/229934530-b586eac0-6c14-4a9e-82c2-4f8ff44ae0dd.mov

Lucrezia-Cester commented 1 year ago

@tomaroberts, @heyhaleema, could this PR be reviewed please?

sophie22 commented 7 months ago

Task description will be described in the ReadTheDocs autogenerated from the hazenlib docstrings and additional descriptions by MR physicists to other users. This PR and change is no longer required.