Skip to content

Provide a list of bad and good code examples to resolve errors codes #3708

Closed
@sprytnyk

Description

@sprytnyk

I really like pylint and use it everywhere but sometimes it isn't obvious from error codes and its
description of what exactly needs to be fixed, changed, especially for beginners. pylint is missing
something like shellcheck has got. See:
https://github.com/koalaman/shellcheck/wiki/SC1000

It would be great to provide people with code examples as long as it more obvious what needs to be
changed. I've created separately a repo to solve this. Sure, it doesn't have for all error codes
bad/good examples of code, rationalisation (some of them may be improved too) yet but it's better than
nothing. By the way, I've created a dummy CLI to be used from terminal too, so when you get any error
you can clarify it as well. See:
https://github.com/vald-phoenix/pylint-errors

For instance, I was really confused with this one:
https://github.com/vald-phoenix/pylint-errors/blob/master/plerr/errors/refactoring/R1710.md

This may be used as food for thoughts for pylint repo.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions