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 #2

Open
PythonFZ opened this issue Feb 2, 2023 · 0 comments · May be fixed by #35
Open

add docstrings #2

PythonFZ opened this issue Feb 2, 2023 · 0 comments · May be fixed by #35
Assignees

Comments

@PythonFZ
Copy link
Member

PythonFZ commented Feb 2, 2023

Currently we do not lint for docstrings:

ZnFlow/pyproject.toml

Lines 45 to 50 in 378e8ff

[tool.ruff]
line-length = 90
select = ["E", "F"] #, "D"] #, "N", "C", "ANN"]
extend-ignore = [
"D213", "D203"
]

this should be changed to select = ["E", "F", "D", "N", "C", "ANN"] with as few as possible exclusions.
Doing so, will require adding docstrings and type hints to the code.

@Ruttor Ruttor linked a pull request Feb 24, 2023 that will close this issue
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

Successfully merging a pull request may close this issue.

2 participants