♻️ Optimize syntax and beautify the code

[patrikspiess]

• Update docstrings
  • No more types in Args: and Returns: because they are already in function/method definition
  • Aligning texts
• Update Logs
  • Surround %s with ' so they are printed in different color
  • Start all log and error messages with Uppercae
• Remove unused blank lines
• Add blank lines after indented blocks
• Change typing Union[xyz, None] to Optional[xyz]
• Other simple changes

[patrikspiess]

Very good an thorough cleanup of the code!!

For better legibility I propose to also change the following:

• Every Python keyword that results in a following block (if, for, with, ...) should be prepended with a blank line, except

  • If the line before is a line comment describing the condition or block
  • If the preceding line is solely for defining a variable that gets used/filled in the block

I would apply the same rules for return statements.

I pointed out quite a lot of spots that had a direct change, I saw there are more places in the code which would need cleanup based on my proposal.

If you agree with this proposal please update the pull request again, otherwise I will look again at the pull request and approve it.

Thank you. I went over all the files and added/removed blank lines as by your suggestion.