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

Fix tape_expand.py documentation examples #6812

Merged
merged 5 commits into from
Jan 15, 2025
Merged

Conversation

andrijapau
Copy link
Contributor

@andrijapau andrijapau commented Jan 13, 2025

Fixes some out-of-date doc string examples that were found.

Only the set_decomposition docstring is user facing, but it is good to keep internal doc strings up to date as well.

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.

@andrijapau andrijapau changed the title Fix documentation examples Fix tape_expand.py documentation examples Jan 13, 2025
Copy link

codecov bot commented Jan 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.60%. Comparing base (14c61a6) to head (866c49d).
Report is 3 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #6812   +/-   ##
=======================================
  Coverage   99.60%   99.60%           
=======================================
  Files         476      476           
  Lines       45215    45167   -48     
=======================================
- Hits        45035    44988   -47     
+ Misses        180      179    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@JerryChen97 JerryChen97 self-requested a review January 13, 2025 15:49
@andrijapau andrijapau requested a review from albi3ro January 13, 2025 15:56
Copy link
Contributor

@JerryChen97 JerryChen97 left a comment

Choose a reason for hiding this comment

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

The modifications look good to me. However, shall we add some information in description to indicate that the changes made here would not be reflected to the rendered docs? since it seems that some of the methods involved here, e.g. create_decomp_expand_fn, have been totally invisible since the latest at the current point. (check via: https://pennylane.ai/search?contentType=DOC&q=create_decomp_expand_fn&version=latest)

It might be helpful as well if we can quickly check which user-faced API's call these functionalities here, and make sure no more adjustments are needed there. If it turns out to be a totally internal change which does not require further mods we might also want to mention in the PR description.

@JerryChen97 JerryChen97 self-requested a review January 13, 2025 18:36
@andrijapau andrijapau added the merge-ready ✔️ All tests pass and the PR is ready to be merged. label Jan 14, 2025
@andrijapau andrijapau enabled auto-merge (squash) January 15, 2025 18:47
@andrijapau andrijapau merged commit 75c1671 into master Jan 15, 2025
45 checks passed
@andrijapau andrijapau deleted the fix-decomp-doc-string branch January 15, 2025 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge-ready ✔️ All tests pass and the PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants