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

ApproxTimeEvolution.compute_decomposition docstring has example #4354

Merged

Conversation

isaacdevlugt
Copy link
Contributor

Context:

The docstring of compute_decomposition for ApproxTimeEvolution is slightly misleading with the coeffs_and_time argument.

Description of the Change:

Adds an example to the docstring to clear things up.

Related GitHub Issues:

https://discuss.pennylane.ai/t/approxtimeevo-decomposition-bug/3178/2

@github-actions
Copy link
Contributor

Hello. You may have forgotten to update the changelog!
Please edit doc/releases/changelog-dev.md with:

  • A one-to-two sentence description of the change. You may include a small working example for new features.
  • A link back to this PR.
  • Your name (or GitHub username) in the contributors section.

@codecov
Copy link

codecov bot commented Jul 12, 2023

Codecov Report

Merging #4354 (df9c8eb) into master (d9382ef) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #4354   +/-   ##
=======================================
  Coverage   99.79%   99.79%           
=======================================
  Files         351      351           
  Lines       32120    32120           
=======================================
  Hits        32053    32053           
  Misses         67       67           
Impacted Files Coverage Δ
...ane/templates/subroutines/approx_time_evolution.py 100.00% <ø> (ø)

Copy link
Contributor

@timmysilv timmysilv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

aside from Christina's comments, the docs lgtm! thanks for adding this 🎉

@timmysilv timmysilv changed the title docstring has example ApproxTimeEvolution.compute_decomposition docstring has example Jul 12, 2023
Copy link
Contributor

@albi3ro albi3ro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 👍

@isaacdevlugt isaacdevlugt enabled auto-merge (squash) July 13, 2023 12:13
@isaacdevlugt isaacdevlugt merged commit 327b672 into master Jul 13, 2023
42 checks passed
@isaacdevlugt isaacdevlugt deleted the approx-time-evolution-compute-decomposition-docstring-fix branch July 13, 2023 12:48
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.

3 participants