-
-
Notifications
You must be signed in to change notification settings - Fork 767
Fix a load of linting issues #12261
Copy link
Copy link
Closed
Labels
audience/nvda-devPR or issue is relevant to NVDA / Add-on developersPR or issue is relevant to NVDA / Add-on developersneeds-technical-investigationA technical investigation is required to progress the issue.A technical investigation is required to progress the issue.p5https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priorityhttps://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#prioritytriagedHas been triaged, issue is waiting for implementation.Has been triaged, issue is waiting for implementation.
Metadata
Metadata
Assignees
Labels
audience/nvda-devPR or issue is relevant to NVDA / Add-on developersPR or issue is relevant to NVDA / Add-on developersneeds-technical-investigationA technical investigation is required to progress the issue.A technical investigation is required to progress the issue.p5https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priorityhttps://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#prioritytriagedHas been triaged, issue is waiting for implementation.Has been triaged, issue is waiting for implementation.
I am analysing the NVDA codebase for a university course and I noticed there are many linting issues such as whitespaces that show up when you run Flake8 on the whole source folder instead of the diffs.
Is your feature request related to a problem? Please describe.
There are many linting issues in the source code that can be fixed with auto-formatting.
Describe the solution you'd like
Apply an auto-formatter on all or the most important files.
Describe alternatives you've considered
Not all Flake8 erros are fixed with auto-formatting, so you could fix all the auto-format warnings in one go and leave in the other problems, or you could focus file by file and fix the other issues manually. In that case it would probably be a good plan to focus on important files first.
Regardless of that, it might be more practical to do only a couple of files at a time, since other people are also working on changes of course.
Additional context
Currently linting is only checked on the diffs. When you check the full project, it is full of old linting issues. If a large batch of these are fixed in one go, it would become easier for others to contribute, since they will not have to deal with as many existing issues they are asked to fix, just because they had to change those lines.
I would be happy to take up this issue if the community thinks this is a good thing to do. If so, my main question is if I should focus on a couple of files and any thoughts on what files would be the most important.