projectmesa / mesa-frames

Extension of mesa for performance and scalability
https://projectmesa.github.io/mesa-frames
Apache License 2.0
13 stars 4 forks source link

Enforce correct numpy docstring formatting with ruff.pydocstyle #74

Closed adamamer20 closed 3 weeks ago

adamamer20 commented 3 weeks ago

This PR adds D rules with the numpy docstring convention to ruff and modifies files to comply with the new rules. This allows for complete and consistent API documentation deployment with sphinx.

NOTE: I had to ignore D101, D102, D105 because ruff doesn't handle inheritance well currently (see https://github.com/astral-sh/ruff/issues/2413)

codecov[bot] commented 3 weeks ago

Codecov Report

Attention: Patch coverage is 90.90909% with 3 lines in your changes missing coverage. Please review.

Files Patch % Lines
mesa_frames/abstract/space.py 66.66% 2 Missing :warning:
mesa_frames/abstract/agents.py 66.66% 1 Missing :warning:
Files Coverage Δ
mesa_frames/__init__.py 100.00% <ø> (ø)
mesa_frames/abstract/mixin.py 100.00% <ø> (ø)
mesa_frames/concrete/agents.py 95.56% <100.00%> (-0.03%) :arrow_down:
mesa_frames/concrete/model.py 75.86% <ø> (+1.66%) :arrow_up:
mesa_frames/concrete/pandas/agentset.py 88.23% <100.00%> (-0.06%) :arrow_down:
mesa_frames/concrete/pandas/mixin.py 86.91% <100.00%> (ø)
mesa_frames/concrete/pandas/space.py 100.00% <ø> (ø)
mesa_frames/concrete/polars/agentset.py 86.04% <ø> (-0.06%) :arrow_down:
mesa_frames/concrete/polars/mixin.py 96.05% <ø> (ø)
mesa_frames/concrete/polars/space.py 98.71% <100.00%> (ø)
... and 3 more
rht commented 3 weeks ago

cc: @EwoutH we should do this for core Mesa as well.