-
-
Notifications
You must be signed in to change notification settings - Fork 378
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 full violations codes to docs #2409
Add full violations codes to docs #2409
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, this is amazing!
There are several nitpicks about code style, but other than that - I am happy to merge this! 🎉
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
# We use this code to show base metrics and thresholds mostly: | ||
postfix_template: ClassVar[ViolationPostfixes] = ( | ||
ViolationPostfixes.bigger_than | ||
) | ||
|
||
def __init_subclass__(cls) -> None: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This causes WPS338
error. Considering that #2411 is in place, what should be our course of action?
I see the following options:
- Suppress the error until Add __init_subclass__ to the methods order #2411 gets released
- Obey current rules of ordering, refactor once Add __init_subclass__ to the methods order #2411 gets released
- Do nothing, wait until Add __init_subclass__ to the methods order #2411 gets released
Sorry for the initial mess. I believe now the only thing that would make CI unhappy is WPS338 (#2409 (comment)) |
Codecov Report
@@ Coverage Diff @@
## master #2409 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 120 120
Lines 6408 6425 +17
Branches 1445 1447 +2
=========================================
+ Hits 6408 6425 +17
Continue to review full report at Codecov.
|
Thank you! |
I made full violations codes indexable
Finally, people searching for
WPS527 Sovereign Starter Motor
will see that WPS truly means!Changes
BaseViolation.__doc__
BaseViolation.full_code
class varBaseViolation.summary
class carBaseViolation._full_name
is now aclassmethod
How it looks in docs
Checklist
CHANGELOG.md
Related issues
Closes #2288
Closes #1145
🙏 Please, if you or your company is finding wemake-python-styleguide valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/wemake-python-styleguide. As a thank you, your profile/company logo will be added to our main README which receives hundreds of unique visitors per day.