uiowaSEP2024 / 002_ImagePro

Image processing backend

1 stars 0 forks source link

Adding DocStrings #93

Closed Ivan-E-Johnson closed 6 months ago

Ivan-E-Johnson commented 7 months ago

Overview

Adding DocStrings on top of the #92 PR. This is for the future so we can add Autodocs and improve the readability of the codebase

Implementation

Adding Doc Strings and typehints to get rid of warnings

Testing

N/A

Notes

This is not quite complete

Ivan-E-Johnson commented 7 months ago

@powersaudrey25 Can you look into the failing tests? I think most of them are due to path changes.

I also think that we should disable the need for sonar to pass and we just run it and merge / make changes from there depending on the severity of the sonar failures. @mbrzus @powersaudrey25 @zmorris248 What are your opinions?

sonarcloud[bot] commented 6 months ago

Quality Gate failed

Failed conditions
39 Security Hotspots
E Reliability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

idea Catch issues before they fail your Quality Gate with our IDE extension SonarLint