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

[CI] Linting of docs #1296

Open
eddiebergman opened this issue Jan 7, 2024 · 1 comment
Open

[CI] Linting of docs #1296

eddiebergman opened this issue Jan 7, 2024 · 1 comment

Comments

@eddiebergman
Copy link
Collaborator

Currently there is no linter for doc and docstrings.

As a follow up, this should really be linted. I would advocate using ruff but theoretically that's blocked on still supporting python 3.6 (#1083).

Should work if working in an environment that's 3.7+ though.

The alternative is to use pydocstyle.

This would prevent issues like #716 from appearing. (which I guess can be closed now?)

@PGijsbers
Copy link
Collaborator

ruff is the way to go here I think. Since we want to drop 3.6 and fewer tools for the same functional behavior is better.

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

2 participants