search

XanaduAI / strawberryfields

Strawberry Fields is a full-stack Python library for designing, simulating, and optimizing continuous variable (CV) quantum optical circuits.
https://strawberryfields.ai
Apache License 2.0
747 stars 186 forks source link

update the PR template #585

Closed jakeffbulmer closed 2 years ago

jakeffbulmer commented 3 years ago

In the PR template, it says: "Ensure that code is properly formatted, by running make format or black -l 100 strawberryfields. You will need to have the Black code format installed: pip install black."

If you run this, it will change ~80 files, mostly in doc and tests, which would crowd any of the intentional changes of the PR, and maybe cause unwanted changes in these files. Perhaps it could say:

"Ensure that code is properly formatted, by running black -l 100 <filename> on any relevant files. You will need to have the Black code format installed: pip install black. Please do not run on test files."

josh146 commented 3 years ago

Thanks @jakeffbulmer! Ah, I see the issue now: we wrote black -l 100 strawberryfields assuming you are already in the main repo (so at the same level as the setup.py) and are instead blacking the interior strawberryfields folder.

Regarding the test: we actually should black the tests :) However, probably best to do this in a separate PR!