Skip to content

Clarify syntax in pylint.lint example #5260

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

Merged
merged 2 commits into from
Nov 13, 2021

Conversation

felixvd
Copy link
Contributor

@felixvd felixvd commented Nov 5, 2021

This makes the call in the documentation non-trivial, so that idiots like me don't get stuck.

If someone could show how to get the output of the command (as asked here), that would also be very helpful to add.

  • Add yourself to CONTRIBUTORS if you are a new contributor.
  • Add a ChangeLog entry describing what your PR does.
  • If it's a new feature, or an important bug fix, add a What's New entry in
    doc/whatsnew/<current release.rst>.
  • Write a good description on what the PR does.

Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

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

Thank you for the better example ! I think your commit message so idiots don't me get stuck. could be reordered to so it's harder to get stuck. More seriously could you add yourself to the contributors, please ? :)

I'll keep the stackoverflow question in mind, I did not manage to make it work myself yet, which is a clue that new documentation will be required.

@coveralls
Copy link

coveralls commented Nov 5, 2021

Pull Request Test Coverage Report for Build 1431158554

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 93.342%

Totals Coverage Status
Change from base Build 1427293421: 0.0%
Covered Lines: 13767
Relevant Lines: 14749

💛 - Coveralls

This makes the call non-trivial and demonstrates the syntax more fully.
@felixvd
Copy link
Contributor Author

felixvd commented Nov 7, 2021

Done. I assumed it's not worth making an entry in the file for such a small contribution, but if it's policy then sure.

@DanielNoord
Copy link
Collaborator

I'll keep the stackoverflow question in mind, I did not manage to make it work myself yet, which is a clue that new documentation will be required.

I have investigated this a bit more. Without changes to Run I think this is simply impossible. The way we change .out and ._output doesn't really allow to do this with Run.
When using PyLinter this might be possible, but I'm not sure we want to create documentation telling people to access it directly. In any case, we could open an issue to track this and close this PR (waiting for a change to Run seems incorrect).

@Pierre-Sassoulas
Copy link
Member

Without changes to Run I think this is simply impossible.

That was my conclusion too. I had the impression it was a problem with kwargs not being taken into account, but I did not go in depth. Do you want to create the issue @DanielNoord ?

I'm not sure we want to create documentation telling people to access it directly

I pretty much agree, I think we need Run to be the entry-point. Especially as we will want to make change to Pylinter later as it's so bloated.

@DanielNoord
Copy link
Collaborator

Opened an issue to track the output issue :)

Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

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

I'm merging as this is still clearer than what we had before. Follow up to be able to recover the output in a stream is #5295.

@Pierre-Sassoulas Pierre-Sassoulas merged commit 9e2f9b3 into pylint-dev:main Nov 13, 2021
@felixvd felixvd deleted the patch-1 branch November 15, 2021 05:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants