[com4FlowPy]: Add docstrings to functions

[PaulaSp3]

Added docstrings to function.

• I almost didn't change existing docstrings/ documentation
• I'm not sure how to document the object methods properly (flowClass.py)

[pep8speaks]

Hello @PaulaSp3! Thanks for updating this PR.

• In the file avaframe/com4FlowPy/com4FlowPy.py:

Line 537:13: E265 block comment should start with '# '
Line 536:13: E265 block comment should start with '# '
Line 332:121: E501 line too long (121 > 120 characters)

• In the file avaframe/com4FlowPy/rasterIo.py:

Line 120:5: E722 do not use bare 'except'
Line 111:5: E722 do not use bare 'except'
Line 86:5: E722 do not use bare 'except'

Comment last updated at 2024-12-04 10:29:50 UTC

[fso42]

@PaulaSp3: This is where the docstring ends up: https://docs.avaframe.org/en/latest/_autosummary/com4FlowPy.flowClass.Cell.html#com4FlowPy.flowClass.Cell .
Looking at it, I think if you specifiy the input after the "constructor for the cell..." bit, you should be fine....

[qlty-cloud-legacy]

Code Climate has analyzed commit 1bd5104 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 0.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 69.5%.

View more on Code Climate.