Add alt text to images #13555

beckykd · 2024-12-11T17:05:10Z

We need to add alt text to images for accessibility.

CLAassistant · 2024-12-11T17:05:16Z

All committers have signed the CLA.

coveralls · 2024-12-11T17:52:33Z

Pull Request Test Coverage Report for Build 12401585817

Details

0 of 0 changed or added relevant lines in 0 files are covered.
3 unchanged lines in 2 files lost coverage.
Overall coverage increased (+0.006%) to 88.967%

Files with Coverage Reduction	New Missed Lines	%
crates/accelerate/src/unitary_synthesis.rs	1	92.2%
crates/qasm2/src/lex.rs	2	93.48%

Totals
Change from base Build 12395850432:	0.006%
Covered Lines:	79441
Relevant Lines:	89293

💛 - Coveralls

…erra into BD-add-alt-text

qiskit-bot · 2024-12-18T19:03:30Z

One or more of the following people are relevant to this code:

@enavarro51
@Cryoris
@Qiskit/terra-core
@ajavadia
@levbishop
@nkanazawa1989
@t-imamichi

qiskit/circuit/library/fourier_checking.py

qiskit/pulse/instruction_schedule_map.py

Co-authored-by: Eric Arellano <[email protected]>

ElePT

Thanks for this PR! I think it's a good start, but I wonder if we would like to eventually make it a bit more informative, because the descriptions are still very generic. I suggested a few minor changes on some descriptions (circuit diagram output instead of output), but overall LGTM. Reviewing this PR also gave me the chance to catch a few documentation bugs (#13635)!

ElePT · 2025-01-08T15:43:08Z

qiskit/qasm3/__init__.py

@@ -130,6 +130,7 @@
 convert it into a :class:`.QuantumCircuit`:

 .. plot::
+    :alt: Output from the previous code.


I think this is a case of:

Suggested change

:alt: Output from the previous code.

:alt: Circuit diagram output by the previous code.

ElePT · 2025-01-08T15:45:15Z

qiskit/synthesis/arithmetic/multipliers/hrs_cumulative_multiplier.py

@@ -27,6 +27,7 @@ def multiplier_cumulative_h18(
    performs a non-modular multiplication on two 3-qubit sized registers is:

    .. plot::
+        :alt: Output from the previous code.


Suggested change

:alt: Output from the previous code.

:alt: Circuit diagram output by the previous code.

ElePT · 2025-01-08T15:46:06Z

qiskit/synthesis/arithmetic/multipliers/rg_qft_multiplier.py

@@ -35,6 +35,7 @@ def multiplier_qft_r17(
    For example, on 3 state qubits, a full multiplier is given by:

    .. plot::
+        :alt: Output from the previous code.


Suggested change

:alt: Output from the previous code.

:alt: Circuit diagram output by the previous code.

ElePT · 2025-01-08T15:48:43Z

qiskit/transpiler/__init__.py

@@ -395,6 +398,7 @@
 :meth:`.CouplingMap.build_coupling_map`:

 .. plot::
+   :alt: Output from the previous code.


Probably out of scope for this PR, but I don't see the output for these 3 snippets in https://docs.quantum.ibm.com/api/qiskit/transpiler#representing-quantum-computers

ElePT · 2025-01-08T15:49:27Z

qiskit/transpiler/__init__.py

@@ -539,6 +544,7 @@
 For example, to run a simple phase estimation circuit:

 .. plot::
+   :alt: Output from the previous code.


Suggested change

:alt: Output from the previous code.

:alt: Circuit diagram output by the previous code.

ElePT · 2025-01-08T15:54:42Z

qiskit/transpiler/__init__.py

@@ -970,6 +989,7 @@
 we can then call :func:`~.transpile` on it with ``scheduling_method`` set:

 .. plot::
+   :alt: Output from the previous code.


Suggested change

:alt: Output from the previous code.

:alt: Circuit diagram output by the previous code.

ElePT · 2025-01-08T15:55:04Z

qiskit/transpiler/__init__.py

@@ -989,6 +1009,7 @@
 also look at it with the :func:`.timeline.draw` function:

 .. plot::
+   :alt: Diagram illustrating the previously described circuit.


I don't think any of the 3 generic descriptions really fit this one, what about?

Suggested change

:alt: Diagram illustrating the previously described circuit.

:alt: Output from circuit timeline drawer.

ElePT · 2025-01-08T15:59:58Z

qiskit/transpiler/layout.py

@@ -455,6 +455,7 @@ class TranspileLayout:
    let the input circuit be:

    .. plot::
+       :alt: Output from the previous code.


Suggested change

:alt: Output from the previous code.

:alt: Circuit diagram output by the previous code.

ElePT · 2025-01-08T16:00:07Z

qiskit/transpiler/layout.py

@@ -470,6 +471,7 @@ class TranspileLayout:
    Suppose that during the layout stage the transpiler reorders the qubits to be:

    .. plot::
+       :alt: Output from the previous code.


Suggested change

:alt: Output from the previous code.

:alt: Circuit diagram output by the previous code.

ElePT · 2025-01-08T16:00:16Z

qiskit/transpiler/layout.py

@@ -498,6 +500,7 @@ class TranspileLayout:
    becomes:

    .. plot::
+       :alt: Output from the previous code.


Suggested change

:alt: Output from the previous code.

:alt: Circuit diagram output by the previous code.

Add alt text to images

5edf643

beckykd added 3 commits December 11, 2024 11:08

Update operation.py

4474eb6

Update parameter.py

4ad57ac

Update quantumcircuit.py

b10af93

beckykd added 11 commits December 11, 2024 13:04

try breaking line

c38a3c7

Update __init__.py

833d009

Update fourier_checking.py

e27d873

Update graph_state.py

d0fbad4

Update grover_operator.py

886c331

add more alt text and some missing directives

8a5ee1f

add nofigs for missing figures

c5cf51b

Add more alt text

2c7b877

next set

b447509

need different text when there's no code

b9a59d6

fix text when no code

8c1cbbc

beckykd mentioned this pull request Dec 11, 2024

Add alt text to API docs Qiskit/documentation#2408

Open

9 tasks

beckykd and others added 12 commits December 11, 2024 15:52

more alt text

d2a1c54

remove brackets

fe25141

Merge branch 'main' into BD-add-alt-text

2aae2e8

More alt text and some fixes

6324af5

Adding more text

c77efe2

more alt text

2dea884

missing file name

6065b15

missing blank line

15d40bd

extra blank line

ee7f758

Merge branch 'main' into BD-add-alt-text

c7fa1a5

update allowlist

ea3afd8

Merge branch 'BD-add-alt-text' of https://github.com/beckykd/qiskit-t…

caf8ebf

…erra into BD-add-alt-text

beckykd and others added 4 commits December 18, 2024 10:31

Merge branch 'main' into BD-add-alt-text

f47c88b

fix spacing

66d84ad

Merge branch 'BD-add-alt-text' of https://github.com/beckykd/qiskit-t…

2e73ce2

…erra into BD-add-alt-text

add more alt text

b31c0dd

beckykd marked this pull request as ready for review December 18, 2024 19:03

beckykd requested review from a team, nonhermitian, alexanderivrii, ShellyGarion, eggerdj, wshanks and jyu00 as code owners December 18, 2024 19:03

Eric-Arellano previously approved these changes Dec 18, 2024

View reviewed changes

qiskit/circuit/library/fourier_checking.py Outdated Show resolved Hide resolved

qiskit/circuit/library/fourier_checking.py Outdated Show resolved Hide resolved

qiskit/pulse/instruction_schedule_map.py Outdated Show resolved Hide resolved

Apply suggestions from code review

7ec1473

Co-authored-by: Eric Arellano <[email protected]>

beckykd dismissed Eric-Arellano’s stale review via 7ec1473 December 18, 2024 21:24

beckykd requested a review from ElePT January 6, 2025 15:42

ElePT reviewed Jan 8, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add alt text to images #13555

Add alt text to images #13555

beckykd commented Dec 11, 2024

CLAassistant commented Dec 11, 2024 •

edited

Loading

coveralls commented Dec 11, 2024 •

edited

Loading

qiskit-bot commented Dec 18, 2024

ElePT left a comment •

edited

Loading

ElePT Jan 8, 2025

ElePT Jan 8, 2025

ElePT Jan 8, 2025

ElePT Jan 8, 2025

ElePT Jan 8, 2025

ElePT Jan 8, 2025

ElePT Jan 8, 2025

ElePT Jan 8, 2025

ElePT Jan 8, 2025

ElePT Jan 8, 2025

	:alt: Output from the previous code.
	:alt: Circuit diagram output by the previous code.

	:alt: Diagram illustrating the previously described circuit.
	:alt: Output from circuit timeline drawer.

Add alt text to images #13555

Are you sure you want to change the base?

Add alt text to images #13555

Conversation

beckykd commented Dec 11, 2024

CLAassistant commented Dec 11, 2024 • edited Loading

coveralls commented Dec 11, 2024 • edited Loading

Pull Request Test Coverage Report for Build 12401585817

Details

💛 - Coveralls

qiskit-bot commented Dec 18, 2024

ElePT left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CLAassistant commented Dec 11, 2024 •

edited

Loading

coveralls commented Dec 11, 2024 •

edited

Loading

ElePT left a comment •

edited

Loading