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

Update top level module documentation #4893

Merged
merged 5 commits into from
Jan 26, 2022
Merged

Update top level module documentation #4893

merged 5 commits into from
Jan 26, 2022

Conversation

dabacon
Copy link
Collaborator

@dabacon dabacon commented Jan 25, 2022

  • Trying to avoid "types and methods" and be more descriptive.
  • Updated top level doc string.
  • See go/q-stage for how this renders.

@dabacon dabacon requested a review from augustehirth January 25, 2022 00:51
@dabacon dabacon requested review from cduck, mrwojtek, vtomole and a team as code owners January 25, 2022 00:51
@dabacon dabacon requested a review from mpharrigan January 25, 2022 00:51
mpharrigan
mpharrigan reviewed Jan 25, 2022
View reviewed changes
cirq-core/cirq/json_resolver_cache.py Outdated
@@ -11,6 +11,7 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Methods for caching json serialization."""
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think the important part is the resolving and not the caching

"""Methods for resolving JSON types during deserialization"""

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Changed.

@CirqBot CirqBot added the size: M 50< lines changed <250 label Jan 25, 2022
augustehirth
augustehirth approved these changes Jan 25, 2022
View reviewed changes
cirq-core/cirq/qis/__init__.py Outdated
@@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Tools and methods for quantum information science."""
"""Tools and methods for primitives arising in quantum information science."""
Copy link
Collaborator

Choose a reason for hiding this comment

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

is "used in" OK here or are the tools and methods really "arising"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is better. Replaced.

cirq-core/cirq/type_workarounds.py Outdated
@@ -12,7 +12,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Module defining NotImplementedType."""
"""Workarounds for python typing gotchas."""
Copy link
Collaborator

Choose a reason for hiding this comment

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

What's the technical term for a "gotcha"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

reworded. "gotcha" is likely not a great word

@MichaelBroughton
Copy link
Collaborator

cc @dstrain115 for breaks in test_create_gate_set_validator for proto wire size flaking.

dabacon
dabacon commented Jan 25, 2022
View reviewed changes
Copy link
Collaborator Author

@dabacon dabacon left a comment

Choose a reason for hiding this comment

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

Addressed comments. Thanks!

cirq-core/cirq/qis/__init__.py Outdated
@@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Tools and methods for quantum information science."""
"""Tools and methods for primitives arising in quantum information science."""
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is better. Replaced.

cirq-core/cirq/type_workarounds.py Outdated
@@ -12,7 +12,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Module defining NotImplementedType."""
"""Workarounds for python typing gotchas."""
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

reworded. "gotcha" is likely not a great word

cirq-core/cirq/json_resolver_cache.py Outdated
@@ -11,6 +11,7 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Methods for caching json serialization."""
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Changed.

@MichaelBroughton MichaelBroughton added the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Jan 26, 2022
@CirqBot
Copy link
Collaborator

CirqBot commented Jan 26, 2022

Automerge cancelled: A status check is failing.

@CirqBot CirqBot removed the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Jan 26, 2022
@MichaelBroughton MichaelBroughton added the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Jan 26, 2022
@CirqBot CirqBot added the front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. label Jan 26, 2022
@CirqBot CirqBot merged commit 2c795d2 into quantumlib:master Jan 26, 2022
@CirqBot CirqBot removed automerge Tells CirqBot to sync and merge this PR. (If it's running.) front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. labels Jan 26, 2022
rht pushed a commit to rht/Cirq that referenced this pull request May 1, 2023
@dabacon @rht
Update top level module documentation (quantumlib#4893)
b9a60ad 
* Trying to avoid "types and methods" and be more descriptive.  
* Updated top level doc string.
* See go/q-stage for how this renders.
harry-phasecraft pushed a commit to PhaseCraft/Cirq that referenced this pull request Oct 31, 2024
@dabacon
Update top level module documentation (quantumlib#4893)
c50b7c9 
* Trying to avoid "types and methods" and be more descriptive.  
* Updated top level doc string.
* See go/q-stage for how this renders.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@augustehirth augustehirth augustehirth approved these changes

@mpharrigan mpharrigan mpharrigan approved these changes

@cduck cduck Awaiting requested review from cduck

@mrwojtek mrwojtek Awaiting requested review from mrwojtek

@vtomole vtomole Awaiting requested review from vtomole

Assignees
No one assigned
Labels
size: M 50< lines changed <250
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@dabacon @MichaelBroughton @CirqBot @mpharrigan @augustehirth