Skip to content

Fix typos in XEB #7254

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

Merged
merged 2 commits into from
Apr 9, 2025
Merged

Fix typos in XEB #7254

merged 2 commits into from
Apr 9, 2025

Conversation

mhucka
Copy link
Contributor

@mhucka mhucka commented Apr 9, 2025

Cross-Entropy Benchmarking should be hyphenated; also, for consistency, it should be either always capitalized or never. Since more places in the docs capitalize it, this commit changes all of them to follow suit.

Cross-Entropy Benchmarking should be hyphenated; also, for
consistency, it should be either always capitalized or never. Since
more places in the docs capitalize it, this commit changes all of them
to follow suit.
@mhucka mhucka marked this pull request as ready for review April 9, 2025 02:19
@mhucka mhucka requested review from mrwojtek, vtomole, a team, wcourtney and verult as code owners April 9, 2025 02:19
@mhucka mhucka self-assigned this Apr 9, 2025
Copy link

codecov bot commented Apr 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.64%. Comparing base (8c8a21a) to head (1a1f45c).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7254   +/-   ##
=======================================
  Coverage   98.64%   98.64%           
=======================================
  Files        1106     1106           
  Lines       95990    95990           
=======================================
+ Hits        94691    94692    +1     
+ Misses       1299     1298    -1     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Collaborator

@pavoljuhas pavoljuhas left a comment

Choose a reason for hiding this comment

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

LGTM. Can you please tuck in an extra one-character fix?

(On mac pbpaste | git apply should work after copying the patch)

diff --git a/docs/transform/custom_transformers.ipynb b/docs/transform/custom_transformers.ipynb
index ab4962f8..e64f4258 100644
--- a/docs/transform/custom_transformers.ipynb
+++ b/docs/transform/custom_transformers.ipynb
@@ -167,3 +167,3 @@
     "### `cirq.TransformerLogger` and support for automated logging\n",
-    "The `cirq.TransformerLogger` class is used to log the actions of a transformer on an input circuit. `@cirq.transformer` decorator automatically adds support for logging the initial and final circuits for each transfomer step. "
+    "The `cirq.TransformerLogger` class is used to log the actions of a transformer on an input circuit. `@cirq.transformer` decorator automatically adds support for logging the initial and final circuits for each transformer step. "
    ]
diff --git a/docs/transform/routing_transformer.ipynb b/docs/transform/routing_transformer.ipynb
index 8f1c5723..415df0ef 100644
--- a/docs/transform/routing_transformer.ipynb
+++ b/docs/transform/routing_transformer.ipynb
@@ -98,3 +98,3 @@
    "source": [
-    "## Routing as a `@cirq.transfomer`"
+    "## Routing as a `@cirq.transformer`"
    ]

@pavoljuhas pavoljuhas added the priority/before-1.5 Finish before the Cirq 1.5 release label Apr 9, 2025
@pavoljuhas pavoljuhas added this pull request to the merge queue Apr 9, 2025
Merged via the queue into quantumlib:main with commit 66c630b Apr 9, 2025
38 checks passed
BichengYing pushed a commit to BichengYing/Cirq that referenced this pull request Jun 20, 2025
* Fix typos in XEB

Cross-Entropy Benchmarking should be hyphenated; also, for
consistency, it should be either always capitalized or never. Since
more places in the docs capitalize it, this commit changes all of them
to follow suit.

* Missed another case of XEB hyphenation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs priority/before-1.5 Finish before the Cirq 1.5 release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants