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

Add docstrings #71

Open
alxndrkalinin opened this issue Dec 14, 2024 · 0 comments
Open

Add docstrings #71

alxndrkalinin opened this issue Dec 14, 2024 · 0 comments

Comments

@alxndrkalinin
Copy link
Collaborator

Most package code is missing docstrings.

Since we switched to ruff for linting and formatting, we can enforce docstrings by adding following to pyproject.toml and to github actions.

[tool.ruff.lint]
select = ["D"]

[tool.ruff.lint.pydocstyle]
convention = "numpy"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant