Skip to content

Commit

Permalink
Add example of class attributes to integration test (#1097)
Browse files Browse the repository at this point in the history
These render worse than we realized. This PR creates a baseline so that
we can see how our changes improve things over time.

See #1098 for the tracking
issue.
  • Loading branch information
Eric-Arellano authored Mar 26, 2024
1 parent 851d92a commit 7dc37ca
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 1 deletion.
16 changes: 16 additions & 0 deletions scripts/lib/api/__snapshots__/conversionPipeline.test.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,22 @@ from api_example import Electron
ELECTRON = Electron(size="2GB", name="QuantumComputing")
\`\`\`
<span id="api_example.Electron.size" />
### size
How big the Electron is.
**Type**
str
<span id="api_example.Electron.name" />
### name
What the Electron is called.
Create an electron.
**Parameters**
Expand Down
Binary file modified scripts/lib/api/testdata/qiskit-sphinx-theme/objects.inv
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=135e06be" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../_static/styles/qiskit-sphinx-theme.css?v=c1078e6d" />
<link rel="stylesheet" type="text/css" href="../_static/jupyter-sphinx.css" />
<link rel="stylesheet" type="text/css" href="../_static/jupyter-sphinx.css?v=572af1d6" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" />
Expand Down Expand Up @@ -291,6 +291,23 @@ <h1>Electron<a class="headerlink" href="#electron" title="Link to this heading">
<span class="n">ELECTRON</span> <span class="o">=</span> <span class="n">Electron</span><span class="p">(</span><span class="n">size</span><span class="o">=</span><span class="s2">&quot;2GB&quot;</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;QuantumComputing&quot;</span><span class="p">)</span>
</pre></div>
</div>
<dl class="py attribute">
<dt class="sig sig-object py" id="api_example.Electron.size">
<span class="sig-name descname"><span class="pre">size</span></span><a class="headerlink" href="#api_example.Electron.size" title="Link to this definition">#</a></dt>
<dd><p>How big the Electron is.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="api_example.Electron.name">
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#api_example.Electron.name" title="Link to this definition">#</a></dt>
<dd><p>What the Electron is called.</p>
</dd></dl>

<p>Create an electron.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down Expand Up @@ -433,6 +450,8 @@ <h1>Electron<a class="headerlink" href="#electron" title="Link to this heading">
<ul>
<li><a class="reference internal" href="#">Electron</a><ul>
<li><a class="reference internal" href="#api_example.Electron"><code class="docutils literal notranslate"><span class="pre">Electron</span></code></a><ul>
<li><a class="reference internal" href="#api_example.Electron.size"><code class="docutils literal notranslate"><span class="pre">Electron.size</span></code></a></li>
<li><a class="reference internal" href="#api_example.Electron.name"><code class="docutils literal notranslate"><span class="pre">Electron.name</span></code></a></li>
<li><a class="reference internal" href="#api_example.Electron.CLASS_ATTRIBUTE"><code class="docutils literal notranslate"><span class="pre">Electron.CLASS_ATTRIBUTE</span></code></a></li>
<li><a class="reference internal" href="#api_example.Electron.charge"><code class="docutils literal notranslate"><span class="pre">Electron.charge</span></code></a></li>
<li><a class="reference internal" href="#api_example.Electron.mass"><code class="docutils literal notranslate"><span class="pre">Electron.mass</span></code></a></li>
Expand Down

0 comments on commit 7dc37ca

Please sign in to comment.