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.

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

Fix docstrings for gatesets and gate families. #4590

Closed
tanujkhattar opened this issue Oct 20, 2021 · 2 comments · Fixed by #5415
Closed

Fix docstrings for gatesets and gate families. #4590

tanujkhattar opened this issue Oct 20, 2021 · 2 comments · Fixed by #5415
Assignees
@dabacon @augustehirth
Labels
area/docstrings area/gatesets kind/bug-report Something doesn't seem to work. kind/docs Documentation related problems, ideas, requests triage/accepted A consensus emerged that this bug report, feature request, or other action should be worked on

Comments

@tanujkhattar
Copy link
Collaborator

Description of the issue

Some docstrings in gatesets and gate families are not getting rendered on the website as expected. For example:

  1. https://quantumai.google/reference/python/cirq/ops/Gateset#__contains__ : Unintentional box, broken hyperlinks, newline missing between bullets etc.
  2. https://quantumai.google/reference/python/cirq/ops/GateFamily#for_example : Ticks in code example instead of syntax highlighting.
  3. https://quantumai.google/reference/python/cirq/ops/GateFamily#expandable-1 : Not hyperlinked.

Cirq version
0.13dev
@tanujkhattar tanujkhattar added kind/bug-report Something doesn't seem to work. kind/docs Documentation related problems, ideas, requests area/gatesets area/docstrings labels Oct 20, 2021
@MichaelBroughton MichaelBroughton added the triage/accepted A consensus emerged that this bug report, feature request, or other action should be worked on label Nov 1, 2021
@unaiic
Copy link
Contributor

unaiic commented Nov 3, 2021

I think I could work on this.

@tanujkhattar tanujkhattar mentioned this issue Mar 25, 2022
Closed
2 tasks
@dabacon dabacon self-assigned this May 26, 2022
@dabacon
Copy link
Collaborator

dabacon commented May 26, 2022

I'll take a crack at these.

@dabacon dabacon mentioned this issue May 27, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dabacon dabacon

@augustehirth augustehirth

Labels
area/docstrings area/gatesets kind/bug-report Something doesn't seem to work. kind/docs Documentation related problems, ideas, requests triage/accepted A consensus emerged that this bug report, feature request, or other action should be worked on
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix docstrings in gate(set|family) dabacon/Cirq
5 participants
@dabacon @MichaelBroughton @tanujkhattar @augustehirth @unaiic