avaframe / AvaFrame

https://avaframe.org
European Union Public License 1.2
16 stars 2 forks source link

[com4FlowPy]: Add docstrings to functions #1030

Open PaulaSp3 opened 3 weeks ago

PaulaSp3 commented 3 weeks ago

Added docstrings to function.

pep8speaks commented 3 weeks ago

Hello @PaulaSp3! Thanks for updating this PR.

Line 543:38: W291 trailing whitespace Line 540:13: E265 block comment should start with '# ' Line 539:13: E265 block comment should start with '# ' Line 336:121: E501 line too long (121 > 120 characters)

Line 151:1: W293 blank line contains whitespace

Line 116:5: E722 do not use bare 'except' Line 107:5: E722 do not use bare 'except' Line 82:5: E722 do not use bare 'except'

Comment last updated at 2024-09-25 09:47:23 UTC
fso42 commented 3 weeks ago

@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....