Skip to content

Add some missing documentation #54

Add some missing documentation

Add some missing documentation #54

Triggered via push September 11, 2024 07:59
Status Failure
Total duration 17s
Artifacts

ruff.yml

on: push
Fit to window
Zoom out
Zoom in

Annotations

10 errors
Ruff (D104): CADETPythonSimulator/__init__.py#L1
CADETPythonSimulator/__init__.py:1:1: D104 Missing docstring in public package
Ruff (D413): CADETPythonSimulator/cake_compressibility.py#L20
CADETPythonSimulator/cake_compressibility.py:20:9: D413 Missing blank line after last section ("Returns")
Ruff (D413): CADETPythonSimulator/cake_compressibility.py#L32
CADETPythonSimulator/cake_compressibility.py:32:5: D413 Missing blank line after last section ("Attributes")
Ruff (D413): CADETPythonSimulator/cake_compressibility.py#L49
CADETPythonSimulator/cake_compressibility.py:49:9: D413 Missing blank line after last section ("Returns")
Ruff (D413): CADETPythonSimulator/cake_compressibility.py#L61
CADETPythonSimulator/cake_compressibility.py:61:5: D413 Missing blank line after last section ("Attributes")
Ruff (D413): CADETPythonSimulator/cake_compressibility.py#L81
CADETPythonSimulator/cake_compressibility.py:81:9: D413 Missing blank line after last section ("Returns")
Ruff (D102): CADETPythonSimulator/componentsystem.py#L102
CADETPythonSimulator/componentsystem.py:102:9: D102 Missing docstring in public method
Ruff (W291): CADETPythonSimulator/solver.py#L227
CADETPythonSimulator/solver.py:227:86: W291 Trailing whitespace
Ruff (D107): CADETPythonSimulator/state.py#L36
CADETPythonSimulator/state.py:36:9: D107 Missing docstring in `__init__`
Ruff (D101): CADETPythonSimulator/system_solver.py#L12
CADETPythonSimulator/system_solver.py:12:7: D101 Missing docstring in public class