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

Code style / autoformat #958

Open
novucs opened this issue Jun 5, 2023 · 2 comments
Open

Code style / autoformat #958

novucs opened this issue Jun 5, 2023 · 2 comments
Labels
question Further information is requested

Comments

@novucs
Copy link
Contributor

novucs commented Jun 5, 2023

This project is awesome and has saved me a lot of time! I've raised a few PRs on this repo now but it's been a little tricky for me to adapt my interpreter settings in a way that does not conflict with your own. Is there a specific code style you're following / do you have any autoformatter settings available (I'm using PyCharm)? I've seen typically on Python OSS projects Black has gotten pretty popular to avoid stepping on each others toes.

@novucs novucs added the question Further information is requested label Jun 5, 2023
@TheTechRobo
Copy link
Contributor

This issue I previously opened should clear up the naming convention: #517

@JustAnotherArchivist
Copy link
Owner

JustAnotherArchivist commented Jun 7, 2023

There isn't. I dislike black for its uncompromising stance of basically not tolerating anything that doesn't exactly follow PEP8. I tried to make it behave one time but gave up pretty soon. Other similar tools at the time weren't any better, but maybe that changed.

Best I can say at the moment is to just follow what's already in use. What comes to mind right now where I deviate from PEP8: tabs for indentation, spaces for alignment; single quotes for strings; no from imports, ever; naming convention as linked above; no real line length limit (as long as it fits on a regular screen and doesn't become unreadable).

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

No branches or pull requests

3 participants