Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enforce correct numpy docstring formatting with ruff.pydocstyle #74

Merged

Conversation

adamamer20
Copy link
Collaborator

@adamamer20 adamamer20 commented Aug 24, 2024

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 astral-sh/ruff#2413)

@adamamer20 adamamer20 linked an issue Aug 24, 2024 that may be closed by this pull request
Copy link

codecov bot commented Aug 24, 2024

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 ⚠️
mesa_frames/abstract/agents.py 66.66% 1 Missing ⚠️
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%) ⬇️
mesa_frames/concrete/model.py 75.86% <ø> (+1.66%) ⬆️
mesa_frames/concrete/pandas/agentset.py 88.23% <100.00%> (-0.06%) ⬇️
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%) ⬇️
mesa_frames/concrete/polars/mixin.py 96.05% <ø> (ø)
mesa_frames/concrete/polars/space.py 98.71% <100.00%> (ø)
... and 3 more

@adamamer20 adamamer20 added docs Improvements or additions to documentation ci Changes to CI configuration files and scripts. labels Aug 24, 2024
@adamamer20 adamamer20 added this to the 0.1.0 Alpha Release milestone Aug 24, 2024
@adamamer20 adamamer20 self-assigned this Aug 24, 2024
@adamamer20 adamamer20 requested a review from rht August 24, 2024 16:25
@rht
Copy link
Contributor

rht commented Aug 24, 2024

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

@adamamer20 adamamer20 merged commit 158a121 into main Aug 24, 2024
6 of 7 checks passed
@adamamer20 adamamer20 deleted the 73-enforce-numpy-docstring-formatting-with-ruffpydocstyle branch August 24, 2024 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Changes to CI configuration files and scripts. docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enforce numpy docstring formatting with ruff.pydocstyle
2 participants