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

[CI] Migrate from YAPF to Black #21311

Closed
9 tasks done
bveeramani opened this issue Dec 31, 2021 · 2 comments
Closed
9 tasks done

[CI] Migrate from YAPF to Black #21311

bveeramani opened this issue Dec 31, 2021 · 2 comments
Assignees

Comments

@bveeramani
Copy link
Member

bveeramani commented Dec 31, 2021

Overview

The Ray Team has decided to format the Ray Python code with Black. This means that going forward, changes to Python code must adhere to the Black code style.

We'll be updating ./scripts/format.sh, so if you're a contributor, your workflow shouldn't change.

Motivation

We're switching to Black because:

  • Code formatted with Black is more readable than code formatted with YAPF.
  • Black is faster than YAPF.
  • Black is the most popular Python formatting tool.

For more information about the motivation behind this change, read the full proposal.

Implementation Plan

We're planning on rolling out the changes in three phases.

Phase One:

Phase Two:

Phase Three:

Timeline

Phase Due Date Status
I 1/1 ✅ Done
II 1/15 1/29 ✅ Done
III 1/31 ✅ Done
@bveeramani bveeramani self-assigned this Dec 31, 2021
@bveeramani bveeramani pinned this issue Dec 31, 2021
pcmoritz pushed a commit that referenced this issue Jan 30, 2022
See #21316 and #21311 for the motivation behind these changes.
dmatrix pushed a commit to dmatrix/ray that referenced this issue Jan 30, 2022
@pcmoritz
Copy link
Contributor

pcmoritz commented Feb 10, 2022

This is now finished, right? Thanks a lot for driving this @bveeramani !

@bveeramani
Copy link
Member Author

There's one last minor PR #21984, but otherwise we're done!

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

No branches or pull requests

2 participants