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.

Sign up for GitHub

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

Jump to bottom

How to apply black formatting #281

Open
jeremyfowers opened this issue Feb 3, 2025 · 0 comments
Open

How to apply black formatting #281

jeremyfowers opened this issue Feb 3, 2025 · 0 comments

Comments

@jeremyfowers
Copy link
Collaborator

We require that all python files in this repo adhere to black formatting. This is enforced with a black check in some CI workflows.

Here's an example of code that is not properly formatted (left) vs. formatted (right):
image

The easiest way to get past this is to enable black formatter in your vscode to format-on-save.

To enable black in your own editor:

  1. Install the extension
    image
  2. Set black as the default formatter
    image
  3. Make sure format-on-save is enabled
    Image
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jeremyfowers