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 documentation for PhasedXZGate #6870

Merged
merged 4 commits into from
Jan 7, 2025
Merged

Fix documentation for PhasedXZGate #6870

merged 4 commits into from
Jan 7, 2025

Conversation

dabacon
Copy link
Collaborator

@dabacon dabacon commented Dec 20, 2024

See documentation on website:
https://quantumai.google/reference/python/cirq/PhasedXZGate?hl=en

This makes the it not subscript the "r"s. I kept this as "math font" instead of making the \tt which is what I would normally due, as this seem to be the standard throughout docs and makes the docstrings more readable.

@dabacon dabacon requested review from vtomole and a team as code owners December 20, 2024 23:25
@CirqBot CirqBot added the Size: XS <10 lines changed label Dec 20, 2024
@dabacon
Copy link
Collaborator Author

dabacon commented Dec 20, 2024

Hello old friend CirqBot

@dabacon dabacon requested a review from pavoljuhas December 20, 2024 23:26
Copy link

codecov bot commented Dec 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@5ffb3ad). Learn more about missing BASE report.
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6870   +/-   ##
=======================================
  Coverage        ?   97.86%           
=======================================
  Files           ?     1084           
  Lines           ?    94299           
  Branches        ?        0           
=======================================
  Hits            ?    92289           
  Misses          ?     2010           
  Partials        ?        0           

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

Copy link
Contributor

@mhucka mhucka left a comment

Choose a reason for hiding this comment

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

Looks reasonable. I know this means the website needs to be updated too, and will make sure that happens.

@mhucka mhucka enabled auto-merge (squash) January 2, 2025 03:41
@mhucka mhucka merged commit b5a04f0 into quantumlib:main Jan 7, 2025
37 checks passed
pavoljuhas added a commit to pavoljuhas/Cirq that referenced this pull request Jan 11, 2025
Avoid spurious one-character subscripts and superscripts.

Follow-up to quantumlib#6870
pavoljuhas added a commit that referenced this pull request Jan 12, 2025
Avoid spurious one-character subscripts and superscripts in HTML docs.

Follow-up to #6870
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Size: XS <10 lines changed
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants