add docstrings

[DeleMike]

• Added Docstrings to all functions in app.py, models.py and some functions in test_pytest.py

Fixes #2

[DeleMike]

@dtemir please review

[winstxnhdw]

Hi @DeleMike, I went ahead and addressed this partially in #30.

[DeleMike]

Oh okay. So what happens now?

[winstxnhdw]

I think we should pick a standard for writing docstrings because our styles are very different and honestly, the PEP rules on docstrings are vague at best.

[DeleMike]

Okay then, I agree that we should have a standard style. We can agree on that after tomorrow's standup. We can get everyone's thoughts. However, is there a standard way?

[dtemir]

Hey @DeleMike @winstxnhdw ! Thank you for the discussion. I had the chance to review Winston's PR #30 first and get it merged. Are there any docstrings outstanding?

[DeleMike]

@dtemir
Yes, @winstxnhdw said all files except app.py follow the Pylint and Pyright ruleset. I assume this file has some outstanding work. Am I correct @winstxnhdw ?

[winstxnhdw]

Yeap. app.py is untouched.