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

Decide for conflicting rules #45

Merged

Conversation

mmacata
Copy link
Member

@mmacata mmacata commented Dec 11, 2024

Depending on the linted files with ruff, the following warnings are shown:

warning: `one-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible. Ignoring `one-blank-line-before-class`.
warning: `multi-line-summary-first-line` (D212) and `multi-line-summary-second-line` (D213) are incompatible. Ignoring `multi-line-summary-second-line`.

This happens because of conflicting pydocstyle rules https://docs.astral.sh/ruff/rules/#pydocstyle-d

This PR decides which ones to ignore. It is merged with the repo specific rules to ignore and cannot be overwritten by repo specific rules to ignore.

@griembauer
Copy link
Member

griembauer commented Dec 12, 2024

Personally I like the style multi-line-summary-second-line better, so I'd opt to ignore the other one. But that's just personal preference I guess.
For the class definitions I have no preferences

@anikaweinmann
Copy link
Member

I am also for the compact rules which Carmen selected.

@mmacata
Copy link
Member Author

mmacata commented Dec 18, 2024

Ok then I will merge :)

@mmacata mmacata merged commit 255a502 into mundialis:main Dec 18, 2024
3 checks passed
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 this pull request may close these issues.

3 participants