SeaShell icon indicating copy to clipboard operation
SeaShell copied to clipboard

[update] Bump pylint score to ~10

Open MannuVilasara opened this issue 1 year ago • 10 comments

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).

MannuVilasara avatar Apr 26 '24 13:04 MannuVilasara

@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.

enty8080 avatar Apr 26 '24 13:04 enty8080

@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

MannuVilasara avatar Apr 26 '24 13:04 MannuVilasara

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

enty8080 avatar Apr 26 '24 13:04 enty8080

@MannuVilasara What command did you run in pylint?

My rating is 8.94/10. Command: pylint seashell

enty8080 avatar Apr 26 '24 13:04 enty8080

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

MannuVilasara avatar Apr 26 '24 13:04 MannuVilasara

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

enty8080 avatar Apr 26 '24 13:04 enty8080

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

MannuVilasara avatar Apr 26 '24 13:04 MannuVilasara

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

enty8080 avatar Apr 26 '24 13:04 enty8080

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.

MannuVilasara avatar Apr 28 '24 08:04 MannuVilasara

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 avatar Apr 28 '24 09:04 enty8080