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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

introducing flake8 to Texthero #159

Open
mk2510 opened this issue Aug 22, 2020 · 5 comments
Open

introducing flake8 to Texthero #159

mk2510 opened this issue Aug 22, 2020 · 5 comments
Labels
enhancement New feature or request

Comments

@mk2510
Copy link
Collaborator

mk2510 commented Aug 22, 2020

I was thinking, that we could improve our overall code quality by using some checker or style guide tools like flake8. From my previous experiences, Uni and Work it was a huge benefit 馃殌 :octocat:

@mk2510 mk2510 added the enhancement New feature or request label Aug 22, 2020
@jbesomi
Copy link
Owner

jbesomi commented Sep 8, 2020

We are already using black, right? As far as I can tell there is no benefit of running flake8 on top of black, I'm missing something?

@mk2510
Copy link
Collaborator Author

mk2510 commented Sep 10, 2020

I got this idea from this post. Flake8 is basically a code linter, which will do some basic static checks. This will help us to prevent basic bugs, like using a variable before it was assigned, etc... . This is especially helpful as python is an interpreted language and in the worst case, some code lines aren't executed with our tests but by some users the first time.

It also should be a bit stricter by coding guidelines so we have a uniformer coding style.

Black won't do those things, but just formats the code right.

@jbesomi
Copy link
Owner

jbesomi commented Jul 1, 2021

Hey @mk2510, have you ever used flake8 before? It would be great to test it on the current codebase and see how many advices it provides. Would you mind try it and let us know?

@mk2510
Copy link
Collaborator Author

mk2510 commented Jul 2, 2021

Hej @jbesomi I used style guides in other projects and languages before. As I am running short on time this July, as my BT takes more time than expected I will have the time again in August to do those tests. 馃槆 :octocat:

@jbesomi
Copy link
Owner

jbesomi commented Jul 2, 2021

Ok, let's talk soon! Thanks, and good luck with your BT!

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