Enforcing `black` for python code formatting

engineerjoe440 / ElectricPy

Electrical Engineering Formulas in Python

https://electricpy.readthedocs.io/en/latest/

MIT License

86 stars 16 forks source link

Enforcing `black` for python code formatting #44

Open Lakshmikanth2001 opened 2 years ago

Lakshmikanth2001 commented 2 years ago

021cfe787fb3d9ac28167b73eafb1198c46dffc4 Sir as our code base is growing in size i want a uniform python code format across all our modules please review it and give your valuable feed bak

engineerjoe440 commented 2 years ago

I'm hesitant with black formatting. I know it's the standard, but there are so many formatting rules that I don't agree with. I've reviewed your PR, and you've managed to make it look VERY good overall. There's a handful of things that the black formatter seems to have gone "too far" with; however, if we're able to get those pieces under control, I think it'll be worth updating. If we're unable to get those pieces, I think it'll be enough to stick with pylint (which is my preference).

Lakshmikanth2001 commented 2 years ago

Black is a PEP 8 compliant opinionated formatter with format whereas pylint is a code linter

pylint just informs where the errors might occur, import optimization, suggest code style
black will format your code insted

engineerjoe440 commented 2 years ago

I've sat on this and been slow; which reflects poorly on me as a maintainer. I want to say though, I've come around to agree with you completely. Not only should we make this repo Black compliant. I think we NEED to have Black compliance in the repo.

I'm definitely onboard! :) Thank you for your persistence, and your patience! :smile:

engineerjoe440 commented 2 years ago

Removing milestone association since this isn't ready to "roll" yet.