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] Bump pylint score to ~10 #32

Open
MannuVilasara opened this issue Apr 26, 2024 · 10 comments
Open

[update] Bump pylint score to ~10 #32

MannuVilasara opened this issue Apr 26, 2024 · 10 comments
Labels
enhancement New feature or request

Comments

@MannuVilasara
Copy link
Contributor

MannuVilasara commented Apr 26, 2024

What is your question?
So I recenty runned the pylint on the codebase and the results aren't that good. So is there any need to fix linting? also a workflow can be created to check wether the project really gets built, linting, formatting etc.

Additional context
image

Any suggestions for the docs?
can work on fixing the linting but will be a large commit (probably gonna sqash commits while merging here).

@enty8080
Copy link
Member

@MannuVilasara Do we need to have 10/10? What's the point of linting? The code is formatted following the PEP8 guidelines, I am not aware of other standards.

@MannuVilasara
Copy link
Contributor Author

@MannuVilasara Do we need to have 10/10? What's the point of linting? The code is formatted following the PEP8 guidelines, I am not aware of other standards.

Yea not really a need but just a suggestion. Can be used while creating workflows

@enty8080
Copy link
Member

Okay, I'll take a look on it in a sec

@enty8080
Copy link
Member

@MannuVilasara What command did you run in pylint?

My rating is 8.94/10. Command: pylint seashell

@MannuVilasara
Copy link
Contributor Author

pylint $(git ls-files '*py')

@enty8080
Copy link
Member

I guess you need to run pylint seashell to check whole module.

@MannuVilasara
Copy link
Contributor Author

Won't it just check for just the seashell file present in bin

@enty8080
Copy link
Member

No, because you are running pylint on a seashell directory (from the root of this repository). It checks for all files located in seashell

@MannuVilasara
Copy link
Contributor Author

No, because you are running pylint on a seashell directory (from the root of this repository). It checks for all files located in seashell

Yea it seems like it. Got the result to be 7.9 now.

@enty8080
Copy link
Member

enty8080 commented Apr 28, 2024

IDK why did you get different result. What is your python version? I guess this might be the reason (mine is 12)

P.S. Anyway, I am currently working on a Pwny official release, so fixing linting problems is not in the plan yet. However, I might take a look at it in the future. Code quality and readability is an essential part.

@enty8080 enty8080 changed the title Linting Issue [update] Bump pylint score to ~10 Apr 28, 2024
@enty8080 enty8080 added the enhancement New feature or request label Apr 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants