testdevlab / Py-TestUI

Apache License 2.0
17 stars 1 forks source link

Finish documenting whole testui package #51

Closed paulsgrudups closed 11 months ago

paulsgrudups commented 1 year ago

This PR contains changes to add docstrings to the whole testui package to provide documentation for the end-user and improve the linter score.

Small improvements were also made to improve the linter score like: 1) Code styling 2) Line length limit wrapping 3) __contains__ conditions rewritten to {value} in format 4) Early function returns in places where within if else statements both scenarios return from function

alvarolaserna commented 1 year ago

Can we add pylint job into the github actions?

TDL-EdgarsEglitis commented 1 year ago

It's probably worth checking whether the new return calls in testui_driver.py don't break anything.

TDL-EdgarsEglitis commented 1 year ago

Would this fully cover the implementation of #32?

alvarolaserna commented 1 year ago

I think so, but we need to add a pylint job to the pipeline to keep things well formatted