Skip to content

Adding pydoclint and properly format docstring #69

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.

Sign up for GitHub

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

Merged
merged 11 commits into from
Aug 20, 2024
Merged

Adding pydoclint and properly format docstring #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f8d109f
adding pydoclint
adamamer20 Aug 20, 2024
599a8ce
pydoclint fix for abstract/agents.py
adamamer20 Aug 20, 2024
f458228
adding DataFrameInput type hint
adamamer20 Aug 20, 2024
8d7c2e2
pydoclint fix for mesa_frames/abstract/mixin
adamamer20 Aug 20, 2024
115fe59
adding raises skip checking
adamamer20 Aug 20, 2024
6ceddf9
allowing init docstring (clearer)
adamamer20 Aug 20, 2024
ecca9c9
pydoclint fix for mesa_frames/abstract/space
adamamer20 Aug 20, 2024
028cf98
pydoclint fixes for mesa_frames.concrete.agents
adamamer20 Aug 20, 2024
48f68a1
pydoclint fixes for mesa_frames/concrete/model
adamamer20 Aug 20, 2024
b1b889e
pydoclint fixes for mesa_frames/concrete/polars/agentset
adamamer20 Aug 20, 2024
463c44e
Merge branch 'main' into pydoclint
adamamer20 Aug 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,8 @@ repos:
"--exclude-file",
"docs/api/search.js",
]
- repo: https://github.com/jsh9/pydoclint
rev: 0.5.6
hooks:
- id: pydoclint
args: [--style=numpy, --skip-checking-raises=True, --allow-init-docstring=True]
Loading