Skip to content

first-pass through tutorials for copyediting #3004

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 41 commits into from
May 1, 2025
Merged

first-pass through tutorials for copyediting #3004

merged 41 commits into from
May 1, 2025

Conversation

abbycross
Copy link
Collaborator

@abbycross abbycross commented Apr 16, 2025

Includes work that will close #2992

In addition to a general copyedit:

  • remove mention of channel=ibm_quantum
  • remove kyiv and sherbrooke (and rerun on new QPUs where necessary)
  • update to new filenames
  • update to new titles
  • update metadata with new titles

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@@ -1265,7 +1264,7 @@
"source": [
"Finally, let's draw a graph based on the CVaR result.\n",
"We split the graph nodes into two sets based on the CVaR result.\n",
"The nodes in the first set are colored in grey, and the nodes in the second set are colored in purple.\n",
"The nodes in the first set are colored in gray, and the nodes in the second set are colored in purple.\n",
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

For accessibility we need a second way to distinguish between the two sets (not just the two colors). @beckykd suggestions?

Copy link
Collaborator

Choose a reason for hiding this comment

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

It depends on what the application is capable of. Can they be pattern filled? Can one be just an outline and one filled?

@abbycross abbycross requested a review from miamico April 30, 2025 19:35
@abbycross
Copy link
Collaborator Author

abbycross commented Apr 30, 2025

@miamico you might want to glance through the changes in qiskit_bot.yaml in 316bd92 to verify that I didn't undo any of your author assignments while resolving a conflict...

@abbycross abbycross marked this pull request as ready for review April 30, 2025 19:51
@qiskit-bot
Copy link
Contributor

@@ -281,7 +281,7 @@
"job = ibm_cf.run(\n",
" pubs=[(circuit, observable)],\n",
" instance=instance,\n",
" backend_name=backend_name, # E.g. \"ibm_kyiv\"\n",
" backend_name=backend_name, # E.g. \"ibm_fez\"\n",
Copy link
Collaborator

Choose a reason for hiding this comment

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

E.g. is one of those Latin abbreviations that we aren't supposed to use. Maybe you want to address these in your follow up PR?

@@ -1265,7 +1264,7 @@
"source": [
"Finally, let's draw a graph based on the CVaR result.\n",
"We split the graph nodes into two sets based on the CVaR result.\n",
"The nodes in the first set are colored in grey, and the nodes in the second set are colored in purple.\n",
"The nodes in the first set are colored in gray, and the nodes in the second set are colored in purple.\n",
Copy link
Collaborator

Choose a reason for hiding this comment

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

It depends on what the application is capable of. Can they be pattern filled? Can one be just an outline and one filled?

@@ -7,7 +7,7 @@
"source": [
"{/* cspell:ignore setminus coloneqq rbrack // latex that isn't being ignored for some reason */}\n",
"\n",
"# Solving Maxcut with Reduced Qubit Requirements Using Pauli Correlation Encoding\n",
"# Pauli Correlation Encoding to reduce Maxcut requirements\n",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Does "correlation encoding" need to be upper case? and "maxcut"?

Copy link
Collaborator

Choose a reason for hiding this comment

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

correlation encoding can be lower case, but I'm not sure about Maxcut

@@ -847,7 +847,7 @@
"version": "3"
},
"platform": "cloud",
"title": "Solve higher-order binary optimization problems with Q-CTRL's Optimization Solver"
"title": "Higher-order binary optimization with Q-CTRL's Optimization Solver"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Q-CTRL is trademarked, so it shouldn't be made possessive.

Copy link
Collaborator

@miamico miamico left a comment

Choose a reason for hiding this comment

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

Looks good!

Copy link
Contributor

@ThomasMerkh ThomasMerkh left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@beckykd beckykd added this pull request to the merge queue May 1, 2025
Merged via the queue into main with commit 9ae3b5f May 1, 2025
4 checks passed
@beckykd beckykd deleted the ajc/copyedits branch May 1, 2025 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Review tutorials titles, URLs, and descriptions
5 participants