metnet icon indicating copy to clipboard operation
metnet copied to clipboard

Fix formatting issues/loosen ruff rules

Open jramosss opened this issue 1 year ago • 6 comments

CI is failing because of the formatting, see We should both loose the rules and fix previous errors

jramosss avatar Jul 03 '24 21:07 jramosss

Thank you @jramosss for doing this

peterdudfield avatar Jul 04 '24 07:07 peterdudfield

im not sure we should loosen the rules. I wonder what is standard when releasing these models?

peterdudfield avatar Jul 04 '24 07:07 peterdudfield

It depends, i'm just thinking maybe marking docstrings as required for every function is a bit extreme for example

jramosss avatar Jul 06 '24 23:07 jramosss

It depends, i'm just thinking maybe marking docstrings as required for every function is a bit extreme for example

how would you suggest loosening the rules?

peterdudfield avatar Jul 08 '24 07:07 peterdudfield

Based on the previous discussion, for the docstring requirement, would there be two options: making it optional or providing docstrings to the required functions?

Averagenormaljoe avatar Mar 24 '25 14:03 Averagenormaljoe

In addition, the lines in the files 'ConditionWithTimeMetNet2.py', 'ConvGRU.py', 'TimeDistributed.py' and 'Preprocessor.py' are considered too long in the CI. These are lines of code related to comments and docstrings; would it be fine to split them into another line to meet the character line limit of 100 in the CI?

Averagenormaljoe avatar Mar 24 '25 14:03 Averagenormaljoe