Skip to content

Try to make docstring render correctly #6283

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Sep 20, 2023
Merged

Try to make docstring render correctly #6283

merged 4 commits into from
Sep 20, 2023

Conversation

eliottrosenberg
Copy link
Collaborator

Docstring does not render correctly on the website: https://quantumai.google/reference/python/cirq/GeneralizedAmplitudeDampingChannel

Maybe putting this equation on one line will fix it?

@eliottrosenberg eliottrosenberg requested review from vtomole, cduck and a team as code owners September 8, 2023 05:13
@CirqBot CirqBot added the Size: XS <10 lines changed label Sep 8, 2023
@codecov
Copy link

codecov bot commented Sep 8, 2023 •
edited
Loading

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (1366494) 97.88% compared to head (f4f3b22) 97.88%.
Report is 1 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #6283   +/-   ##
=======================================
  Coverage   97.88%   97.88%           
=======================================
  Files        1104     1104           
  Lines       95841    95854   +13     
=======================================
+ Hits        93818    93831   +13     
  Misses       2023     2023
Files Changed Coverage Δ
cirq-core/cirq/ops/common_channels.py 99.74% <ø> (ø)
cirq-google/cirq_google/ops/internal_gate.py 100.00% <100.00%> (ø)
cirq-google/cirq_google/ops/internal_gate_test.py 100.00% <100.00%> (ø)

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

dstrain115
dstrain115 approved these changes Sep 16, 2023
View reviewed changes
Copy link
Collaborator

@dstrain115 dstrain115 left a comment

Choose a reason for hiding this comment

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

You could also try single "$" and put it on the same line as via. We can try this though.

@dstrain115 dstrain115 merged commit 907ec3a into quantumlib:master Sep 20, 2023
harry-phasecraft pushed a commit to PhaseCraft/Cirq that referenced this pull request Oct 31, 2024
@eliottrosenberg
Try to make docstring render correctly (quantumlib#6283)
921ecc7 
* Try to make docstring render correctly

Docstring does not render correctly on the website: https://quantumai.google/reference/python/cirq/GeneralizedAmplitudeDampingChannel
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dstrain115 dstrain115 dstrain115 approved these changes

@vtomole vtomole Awaiting requested review from vtomole

@cduck cduck Awaiting requested review from cduck

@95-martin-orion 95-martin-orion Awaiting requested review from 95-martin-orion 95-martin-orion was automatically assigned from quantumlib/cirq-maintainers

Assignees
No one assigned
Labels
Size: XS <10 lines changed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@eliottrosenberg @dstrain115 @CirqBot