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

Add example to AngleEmbedding #1908

Merged
merged 6 commits into from
Nov 17, 2021
Merged

Conversation

ankit27kh
Copy link
Contributor

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 the
    change, 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 then
    run 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

Add example in documentation
@ankit27kh
Copy link
Contributor Author

ankit27kh commented Nov 17, 2021

Hi @antalszava! Is this example acceptable? If yes, similar examples can be made in all templates with further details where necessary.

@codecov
Copy link

codecov bot commented Nov 17, 2021

Codecov Report

Merging #1908 (5ff9140) into master (80a169d) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1908   +/-   ##
=======================================
  Coverage   98.85%   98.85%           
=======================================
  Files         220      220           
  Lines       16972    16972           
=======================================
  Hits        16778    16778           
  Misses        194      194           
Impacted Files Coverage Δ
pennylane/templates/embeddings/angle.py 100.00% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 80a169d...5ff9140. Read the comment docs.

@antalszava
Copy link
Contributor

Hi @ankit27kh, thank you for the addition! 😊

Hi @antalszava! Is this example acceptable? If yes, similar examples can be made in all templates with further details where necessary.

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! 🙂

ankit27kh and others added 2 commits November 17, 2021 22:24
Co-authored-by: antalszava <antalszava@gmail.com>
@ankit27kh
Copy link
Contributor Author

@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. 😄

Copy link
Contributor

@antalszava antalszava left a 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. 👍

@antalszava antalszava merged commit b74f892 into PennyLaneAI:master Nov 17, 2021
@ankit27kh ankit27kh deleted the patch-2 branch November 17, 2021 18:06
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

Successfully merging this pull request may close these issues.

None yet

2 participants