Closed vincentmr closed 3 months ago
👋 Hey, looks like you've updated some demos!
🐘 Don't forget to update the dateOfLastModification
in the associated metadata files so your changes show up on pennylane.ai.
Please hide this comment once the field(s) are updated. Thanks!
Thank you for opening this pull request.
You can find the built site at this link.
Deployment Info:
1078
66b8c0969c1fa988c09f7d00bdd21593e54f9e69
(The Deployment SHA
refers to the latest commit hash the docs were built from)Note: It may take several minutes for updates to this pull request to be reflected on the deployed site.
Hey @vincentmr! we have chosen not to isort and format the demos/tutorials, for a couple of reasons:
unless there is a motivation for doing this in the QML repo, I will close this PR for now.
Hey @vincentmr! we have chosen not to isort and format the demos/tutorials, for a couple of reasons:
- Black will make formatting choices that are not always the best for readability
Being so used to read black
-formatted code, I thought it might help readability in general, but I agree this could make things worse on some cases.
- isort will reorder imports in a way that is not always best for explanation (sometimes we want to import things later in the demo)
Yes, good point.
unless there is a motivation for doing this in the QML repo, I will close this PR for now.
No problem.
Before submitting
Please complete the following checklist when submitting a PR:
[ ] Ensure that your tutorial executes correctly, and conforms to the guidelines specified in the README.
[ ] Remember to do a grammar check of the content you include.
[ ] All tutorials conform to PEP8 standards. To auto format files, simply
pip install black
, and then runblack -l 100 path/to/file.py
.When all the above are checked, delete everything above the dashed line and fill in the pull request template.
Title:
Summary: Add
make format
(isort
+black
). Runmake format
.Relevant references:
Possible Drawbacks:
Related GitHub Issues:
If you are writing a demonstration, please answer these questions to facilitate the marketing process.
GOALS — Why are we working on this now?
Eg. Promote a new PL feature or show a PL implementation of a recent paper.
AUDIENCE — Who is this for?
Eg. Chemistry researchers, PL educators, beginners in quantum computing.
KEYWORDS — What words should be included in the marketing post?
Which of the following types of documentation is most similar to your file? (more details here)
[ ] Tutorial
[ ] Demo
[ ] How-to