-
Notifications
You must be signed in to change notification settings - Fork 575
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
Add example to AngleEmbedding #1908
Conversation
Add example in documentation
Hi @antalszava! Is this example acceptable? If yes, similar examples can be made in all templates with further details where necessary. |
Codecov Report
@@ Coverage Diff @@
## master #1908 +/- ##
=======================================
Coverage 98.85% 98.85%
=======================================
Files 220 220
Lines 16972 16972
=======================================
Hits 16778 16778
Misses 194 194
Continue to review full report at Codecov.
|
Hi @ankit27kh, thank you for the addition! 😊
Yep, this looks awesome! Left some minor comments, but such examples look great. Let me know if you'd like us to leave a review. Don't forget to update the changelog file! 🙂 |
Co-authored-by: antalszava <antalszava@gmail.com>
@antalszava this seems ready then. I'll probably add examples to other templates one at a time. As there are a lot of templates, I will be making separate PRs. Small chunks are easy to manage. 😄 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Thank you 🙂 Other PRs adding new template examples could also just extend the item added in the changelog by another line with the PR number. 👍
Add example in documentation
Before submitting
Please complete the following checklist when submitting a PR:
All new features must include a unit test.
If you've fixed a bug or added code that should be tested, add a test to the
test directory!
All new functions and code must be clearly commented and documented.
If you do make documentation changes, make sure that the docs build and
render correctly by running
make docs
.Ensure that the test suite passes, by running
make test
.Add a new entry to the
doc/releases/changelog-dev.md
file, summarizing thechange, and including a link back to the PR.
The PennyLane source code conforms to
PEP8 standards.
We check all of our code against Pylint.
To lint modified files, simply
pip install pylint
, and thenrun
pylint pennylane/path/to/file.py
.When all the above are checked, delete everything above the dashed
line and fill in the pull request template.
Context:
Some templates do not have examples.
Description of the Change:
Add example to AngleEmbedding documentation
Benefits:
Better documentation
Possible Drawbacks:
N/A
Related GitHub Issues:
#1727 #1735