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

Updated Python Code Style Guidelines #3828

Merged
merged 2 commits into from
Sep 9, 2020
Merged

Conversation

Anutrix
Copy link
Contributor

@Anutrix Anutrix commented Jul 23, 2020

Updated Python Code Style Guidelines to use Black now.

@YuriSizov
Copy link
Contributor

As mentioned in godotengine/godot#40627 this should probably refer to pre-commit hooks instead.

@Anutrix
Copy link
Contributor Author

Anutrix commented Jul 23, 2020

Should I add both pre-commit hooks and the manual way like it's done for clang-format?
If so, the text for that would be almost the same as that for clang-format's pre-commit hook section. Keeping this in mind, should we move pre-commit subsections to separate single section addressing both clang-format and black?

@YuriSizov
Copy link
Contributor

I think it should be mentioned in some general contribution workflow guide, if not already. But it is still worthwhile mentioning the particular hook for python in the article about python code style. So what if it's similar to CLang one. That's fine. And yes, it doesn't hurt to mention both way to call it, but in my opinion the hooks are more important as they automate all kinds of checks.

@Anutrix Anutrix marked this pull request as draft July 23, 2020 16:59
@Anutrix Anutrix force-pushed the patch-2 branch 2 times, most recently from 90c4a2e to ab88c20 Compare July 23, 2020 18:40
@Anutrix Anutrix marked this pull request as ready for review July 23, 2020 18:42
@Anutrix Anutrix force-pushed the patch-2 branch 2 times, most recently from ec85f65 to 8deec55 Compare July 23, 2020 18:52
@Anutrix

This comment has been minimized.

Updated Python Code Style Guidelines to use Black now.
@akien-mga akien-mga merged commit fcbe81e into godotengine:master Sep 9, 2020
@akien-mga
Copy link
Member

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants