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

Update pylint config docs #2931

Merged
merged 5 commits into from Mar 16, 2022
Merged

Update pylint config docs #2931

merged 5 commits into from Mar 16, 2022

Conversation

jpy-git
Copy link
Contributor

@jpy-git jpy-git commented Mar 16, 2022

Description

Closes #2914. I've confirmed that C0330 & C0326 checks no longer exist in pylint, therefore we can remove them from the config docs.

Checklist - did you ...

  • Add a CHANGELOG entry if necessary?
  • Add / update tests if necessary?
  • Add new / update outdated documentation?

CHANGES.md Show resolved Hide resolved

And as usual, Pylint should be configured to only complain about lines that surpass `88`
characters via `max-line-length = 88`.
Pylint should be configured to only complain about lines that surpass `88` characters
Copy link
Contributor

@Shivansh-007 Shivansh-007 Mar 16, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be worth adding a small line/note that this configuration is only applicable latest versions, or to be more precise >= 2.6.0.

Copy link
Contributor Author

@jpy-git jpy-git Mar 16, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense, can see it in the 2.6.0 release notes.

Given there have been a good number of releases since 2.6.0, do you think this can just be something like

N.B. if using `pylint < 2.6.0`, also disable `C0326` and `C0330` as these clash with _Black_ formatting and have since been removed.

or would you rather keep the longer descriptions?

Copy link
Collaborator

@JelleZijlstra JelleZijlstra Mar 16, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a short note like that is good. We can skip the details.

Copy link
Contributor Author

@jpy-git jpy-git Mar 16, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the old error code callout in now 😄

@JelleZijlstra
Copy link
Collaborator

@JelleZijlstra JelleZijlstra commented Mar 16, 2022

When were these codes removed? We may still want to mention them in case people use an older version of pylint or pylint changes its mind.

@Shivansh-007
Copy link
Contributor

@Shivansh-007 Shivansh-007 commented Mar 16, 2022

CO330 is removed by PyCQA/pylint#3571, I am not sure about the other error code but AFAIK its removal was part of the same release.

@jpy-git
Copy link
Contributor Author

@jpy-git jpy-git commented Mar 16, 2022

@Shivansh-007 C0326 was removed in https://github.com/PyCQA/pylint/pull/3577/files (same release as CO330 removal)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
@JelleZijlstra JelleZijlstra merged commit fa7f015 into psf:main Mar 16, 2022
@jpy-git jpy-git deleted the pylint_docs branch Mar 16, 2022
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