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

Parent bug to track progress of docstring bugfixes to improve cirq reference for Cirq 1.0 launch #5151

Open
2 tasks
tanujkhattar opened this issue Mar 25, 2022 · 1 comment
Labels
area/docstrings kind/docs Documentation related problems, ideas, requests kind/health For CI/testing/release process/refactoring/technical debt items

Comments

@tanujkhattar
Copy link
Collaborator

Description of the issue
As part of launching Cirq 1.0, we need to make sure that the docstring reference on our site is polished. This bug is to track the various open issues to fix docstring errors for cirq reference as part of heading towards the Cirq 1.0 launch.

All contributors are encouraged to go through the website and report bugs here. Contributors are also encouraged to send PRs fixing the reported bugs that are consolidated here. We will try to maintain a list of open tasks that need to be fixed.

Reference Website: https://quantumai.google/reference/python/cirq/all_symbols?version=nightly

Cirq version
0.15

cc @MichaelBroughton @95-martin-orion

@tanujkhattar tanujkhattar added kind/health For CI/testing/release process/refactoring/technical debt items kind/docs Documentation related problems, ideas, requests time/before-1.0 labels Mar 25, 2022
@TimoEckstein
Copy link
Contributor

Following Cirq Cync yesterday, I was looking at issue #2405 and saw that a PR by Matthew Neeley from 6 days ago already addresses it. Then, I was looking for another good first issue and found this.
To get started, I wondered whether there is a way to reproduce the Cirq documentation offline, so that I can check whether my changes actually fixed the bugs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docstrings kind/docs Documentation related problems, ideas, requests kind/health For CI/testing/release process/refactoring/technical debt items
Projects
Status: No status
Development

No branches or pull requests

5 participants