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

Style guide #65

Closed
andrewgy8 opened this issue Jun 14, 2019 · 5 comments
Closed

Style guide #65

andrewgy8 opened this issue Jun 14, 2019 · 5 comments
Labels
good first issue Good for newcomers question Further information is requested

Comments

@andrewgy8
Copy link
Contributor

We currently have flake8 in our linting command. We do not have isort in the project style guidelines.

Shall we add it?

Or try out something new like black?

@andrewgy8 andrewgy8 added the question Further information is requested label Jun 17, 2019
@daniel-ruiz
Copy link
Contributor

I have no problem with undertaking either action. To me, black is something I wanted to try out. I see this project could be a good experimentation field for this. After all, it is widely used in other Python open-source projects.

@tobami
Copy link
Contributor

tobami commented Jun 17, 2019

I'd add isort, but not black yet. Not unless we have formatting problems.

@daniel-ruiz
Copy link
Contributor

Why? I never used black, so I may have missed something. Do you see any drawbacks of using it at this point?

@tobami
Copy link
Contributor

tobami commented Jun 18, 2019

I asked Andrew what he meant and he didn't mean to use black for the autoformatting capabilities but as a substitute for flake8 for the reason that it has checks beyond what flake8 offers. In that case I'm OK with trying it out.

@andrewgy8 andrewgy8 added the good first issue Good for newcomers label Jun 18, 2019
@edgarlatorre
Copy link
Contributor

After quick read in the black documentation, IMHO I think it'd be kind of redundant. The differences from fake8 is that black would suggest changes to follow the defined style and for me it would work super well in a private project where you can have an agreement with the developer to use black integrated with you editor. For a open source project I wouldn't mind to have different styles if it does not have any pep8 offence. Also if we are not using auto format, it's kind of annoying to check the diffs with the suggestions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers question Further information is requested
Projects
None yet
Development

No branches or pull requests

4 participants