Skip to content

Conversation

@paulsgrudups
Copy link
Collaborator

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
Copy link
Contributor

Can we add pylint job into the github actions?

@TDL-EdgarsEglitis
Copy link
Collaborator

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

@TDL-EdgarsEglitis
Copy link
Collaborator

Would this fully cover the implementation of #32?

@alvarolaserna
Copy link
Contributor

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

@alvarolaserna alvarolaserna linked an issue Jul 25, 2023 that may be closed by this pull request
Copy link
Collaborator

@TDL-EdgarsEglitis TDL-EdgarsEglitis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose the remaining Pylint warnings should also be fixed eventually, but for now this looks good.

@alvarolaserna alvarolaserna merged commit 654c111 into master Oct 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document modules, functions, classes

4 participants