Skip to content

Commit 55af9e9

Browse files
Update MDX guide and fix some GP issues (#3966)
This PR fixes some files that were causing problems when they were sent to translate & updates the MDX guide to reflect some constrains when using definition tooltips and setting the markdown metadata. --------- Co-authored-by: Eric Arellano <[email protected]>
1 parent dea9a67 commit 55af9e9

File tree

4 files changed

+9
-4
lines changed

4 files changed

+9
-4
lines changed

docs/guides/visualize-results.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
"id": "e8d0138c-fd97-49c2-88a5-1929a5a09258",
3636
"metadata": {},
3737
"source": [
38-
"## Plot histogram <a name='histogram'></a>\n",
38+
"## Plot histogram\n",
3939
"\n",
4040
"The `plot_histogram` function visualizes the result of sampling a quantum circuit on a QPU.\n",
4141
"\n",

docs/migration-guides/migrate-classic-rest-api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ For the whole schema, see the [Qiskit Runtime API.](https://quantum.cloud.ibm.co
106106
| -------- | ------ | ------- |
107107
| GET | `/facade/v1/jobs/tags` | `/v1/tags` |
108108
| GET | `/facade/v1/jobs/\{id\}/type` | **N/A** |
109-
| GET | `/jobs* <br/> `/jobs/\{id\}` <br/> `/jobs/\{id\}/metrics` | `/v1/jobs` <br/> `/v1/jobs/\{id\}` <br/> `/v1/jobs/\{id\}/metrics` |
109+
| GET | `/jobs*` <br/> `/jobs/\{id\}` <br/> `/jobs/\{id\}/metrics` | `/v1/jobs` <br/> `/v1/jobs/\{id\}` <br/> `/v1/jobs/\{id\}/metrics` |
110110
| GET | `/jobs/\{id\}/interim_results` <br/> `/jobs/\{id\}/transpiled_circuits` <br/> `/jobs/\{id\}/logs` | `/v1/jobs/\{id\}/interim_results` <br/> `/v1/jobs/\{id\}/transpiled_circuits` <br/> `/v1/jobs/\{id\}/logs` |
111111
| POST | `/jobs/\{id\}/cancel` | `/v1/jobs/\{id\}/cancel` |
112112
| PUT | `/jobs/\{id\}/tags` | `/v1/jobs/\{id\}/tags` |

learning/courses/quantum-safe-cryptography/quantum-safe-cryptography.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
"source": [
5757
"## Quantum algorithms and impacts to cryptography\n",
5858
"\n",
59-
"| Quantum Algorithm | Functionality | <DefinitionTooltip definition=\"As defined by the [NIST](https://csrc.nist.gov/glossary/term/security_strength): *A number characterizing the amount of work that is expected to suffice to defeat an implemented cryptographic mechanism (for example, by compromising its functionality and/or circumventing the protection that its use was intended to facilitate). Security strength is often expressed in bits. If the security strength of a particular implementation of a cryptographic mechanism is s bits, it is expected that the equivalent of (roughly) 2<sup>s</sup> basic operations of some sort will be sufficient to defeat it in some way.*\">Security Strength</DefinitionTooltip> ($n$ = number of bits) | Impacted Cryptographic Protocols | Mitigation |\n",
59+
"| Quantum Algorithm | Functionality | <DefinitionTooltip definition=\"As defined by the [NIST](https://csrc.nist.gov/glossary/term/security_strength): *A number characterizing the amount of work that is expected to suffice to defeat an implemented cryptographic mechanism (for example, by compromising its functionality and/or circumventing the protection that its use was intended to facilitate). Security strength is often expressed in bits. If the security strength of a particular implementation of a cryptographic mechanism is s bits, it is expected that the equivalent of (roughly) 2<sup>s</sup> basic operations of some sort will be sufficient to defeat it in some way.*\">Security Strength</DefinitionTooltip> ($n$ = number of bits) | Impacted Cryptographic Protocols | Mitigation |\n",
6060
"|-------------------|--------------------|------------------------------------------------------|--------------------------------------------------|------------------------|\n",
6161
"| Shor | factoring | $poly(n)$ | RSA | Migrate to QSC |\n",
6262
"| Shor | discrete logarithm | $poly(n)$ | Diffie-Hellman, DSA, Elliptic Curve Cryptography | Migrate to QSC |\n",

mdx-guide.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ In Jupyter notebooks, set `title` and `description` in the `metadata` section fo
5656
}
5757
```
5858

59+
Avoid using hyphens, colons, semicolons, backticks, and pipes when writing the `title` and `description`. These characters might be used differently in other languages, and their use might complicate the translation process. Our translation tooling often replaces them with other symbols that could change their meaning or even break the page.
60+
5961
## Links
6062

6163
Internal URLs referring to other docs pages should start with `/docs` and not include the file extension. For example:
@@ -219,7 +221,10 @@ To use a `DefinitionTooltip`, use the following syntax:
219221

220222
For full list of props, please check [here](https://react.carbondesignsystem.com/?path=/docs/components-definitiontooltip--playground#component-api).
221223

222-
Warning: do not use LaTeX/math expressions in the same paragraph as a definition tooltip because it will break the styling. Use a new line to separate out the two into separate paragraphs.
224+
Caveats:
225+
226+
1. Do not use any interactive content (e.g. links) with the `definition` prop or inside the tags. If you use such content, it will not be available to users of screen reader software.
227+
2. Do not use single and double quotes in the `definition` prop. Even if they are escaped, they cause problems when translating the files.
223228

224229
### Tabs
225230

0 commit comments

Comments
 (0)