Converting headers into docstrings (Part 2)

[PietropaoloFrisoni]

Description

Related Issues

Closes #
Related to #

Type of Change

• Feature (new functionality)
• Change Request (modification of existing functionality)
• Bug Fix
• Refactoring (no behavior change)
• Performance improvement
• Documentation
• CI / Build

Breaking Change?

• Yes
• No

If yes, describe the impact and migration path:

What was changed?

How was it tested?

Test-ID	Status
T-001	✅ / ❌
T-002	✅ / ❌
T-003	✅ / ❌
T-004	✅ / ❌

Screenshots / Output (if applicable)

Checklist

• My code follows the project's coding standards
• I have performed a self-review
• I have added/updated tests (referencing issue Test-IDs)
• All tests pass locally and in CI
• I have updated the documentation
• I have added a changelog entry to changelog-dev.rst
• Breaking changes are documented with migration path

Reviewer Notes

[Copilot]

🟢 Approval recommended

The documentation-only changes were fully reviewed with no unresolved issues.

Pull request overview

Converts license text from module docstrings into comment headers and adds concise module documentation across the test suite without changing runtime behavior.

Changes:

• Standardized Python license headers as comments.
• Added descriptive test and packaging module docstrings.
• Removed obsolete commented quote markers.

File summaries

File	Description
tools/prepare-release-changelog.py	Converted license header to comments.
tests/test_typing.py	Documented typing tests.
tests/primitives_tests/test_qswitch.py	Documented deprecated qswitch tests.
tests/primitives_tests/test_QAE.py	Documented QAE tests.
tests/primitives_tests/test_q_switch.py	Documented q_switch tests.
tests/primitives_tests/test_IQAE.py	Documented IQAE tests.
tests/primitives_tests/test_dicke_states.py	Documented Dicke-state tests.
tests/primitives_tests/test_cycling_function.py	Documented cycling-function tests.
tests/primitives_tests/test_amplitude_amplification.py	Documented amplitude-amplification tests.
tests/primitives_tests/arithmetic_tests/test_qcla.py	Documented QCLA tests.
tests/operators_tests/test_VQE.py	Documented VQE tests.
tests/operators_tests/test_to_pauli_converter.py	Documented Pauli-conversion tests.
tests/operators_tests/test_qubit_operator.py	Documented QubitOperator tests.
tests/operators_tests/test_qdrift.py	Documented QDrift tests.
tests/operators_tests/test_pyscf_interface.py	Documented PySCF interface tests.
tests/operators_tests/test_operators_LCU.py	Documented operator LCU tests.
tests/operators_tests/test_hamiltonian.py	Documented Hamiltonian tests.
tests/operators_tests/test_from_matrix_converter.py	Documented matrix-conversion tests.
tests/operators_tests/test_fermionic_term.py	Documented FermionicTerm tests.
tests/operators_tests/test_expectation_value.py	Documented expectation-value tests.
tests/jax_tests/test_tracing_quantum_session.py	Documented tracing-session tests.
tests/jax_tests/test_testing_function.py	Documented testing-helper tests.
tests/jax_tests/test_terminal_sampling.py	Documented terminal-sampling tests.
tests/jax_tests/test_template.py	Documented template tests.
tests/jax_tests/test_stim_simulation.py	Documented Stim simulation tests.
tests/jax_tests/test_rus.py	Documented RUS tests.
tests/jax_tests/test_quantum_kernel.py	Documented quantum-kernel tests.
tests/jax_tests/test_qasm_converter.py	Documented QASM-conversion tests.
tests/jax_tests/test_qache.py	Documented qache tests.
tests/jax_tests/test_prefix_control.py	Documented prefix-control tests.
tests/jax_tests/test_post_processing_extraction.py	Documented post-processing tests.
tests/jax_tests/test_num_qubits.py	Documented qubit-counting tests.
tests/jax_tests/test_montgomery.py	Documented Montgomery arithmetic tests.
tests/jax_tests/test_mlir.py	Documented MLIR-generation tests.
tests/jax_tests/test_mlir_rewrites.py	Documented MLIR-rewrite tests.
tests/jax_tests/test_LCU.py	Documented Jasp LCU tests.
tests/jax_tests/test_jaspify.py	Documented jaspify tests.
tests/jax_tests/test_jasp_QuantumFloat.py	Documented QuantumFloat tracing tests.
tests/jax_tests/test_jasp_QuantumBool.py	Documented QuantumBool tracing tests.
tests/jax_tests/test_jasp_quantum_counting.py	Documented quantum-counting tests.
tests/jax_tests/test_jasp_quantum_array.py	Documented QuantumArray tracing tests.
tests/jax_tests/test_jasp_qswitch.py	Documented deprecated qswitch tests.
tests/jax_tests/test_jasp_qite.py	Documented QITE tests.
tests/jax_tests/test_jasp_QAE.py	Documented traced QAE tests.
tests/jax_tests/test_jasp_q_switch.py	Documented traced q_switch tests.
tests/jax_tests/test_jasp_modulus.py	Documented modular-arithmetic tests.
tests/jax_tests/test_jasp_minimize.py	Documented minimization tests.
tests/jax_tests/test_jasp_IQPE.py	Documented IQPE tests.
tests/jax_tests/test_jasp_IQAE.py	Documented traced IQAE tests.
tests/jax_tests/test_jasp_grovers_algorithm.py	Documented traced Grover tests.
tests/jax_tests/test_jasp_custom_control.py	Documented custom-control tests.
tests/jax_tests/test_injection_operator.py	Documented injection-operator tests.
tests/jax_tests/test_HHL_demo.py	Documented HHL demo tests.
tests/jax_tests/test_environment_compilation.py	Documented environment-compilation tests.
tests/jax_tests/test_dynamic_qubit_array.py	Documented dynamic-array tests.
tests/jax_tests/test_dynamic_mcx.py	Documented dynamic MCX tests.
tests/jax_tests/test_depth.py	Documented depth-profiler tests.
tests/jax_tests/test_custom_inverse.py	Documented custom-inverse tests.
tests/jax_tests/test_count_ops.py	Documented operation-count tests.
tests/jax_tests/test_control_flow_capturing.py	Documented control-flow capture tests.
tests/jax_tests/test_control_compilation.py	Documented control-compilation tests.
tests/jax_tests/test_conjugation_env.py	Documented conjugation tests.
tests/jax_tests/test_catalyst_interface.py	Documented Catalyst interface tests.
tests/jax_tests/test_call_graph_analysis.py	Documented call-graph tests.
tests/jax_tests/test_buffered_quantum_state.py	Documented buffered-state tests.
tests/jax_tests/test_boolean_simulation.py	Documented Boolean simulation tests.
tests/jax_tests/test_biginteger.py	Documented BigInteger tests.
tests/jax_tests/test_basic_primitives.py	Documented primitive tests.
tests/jax_tests/test_arithmetic.py	Documented Jasp arithmetic tests.
tests/jax_tests/test_arithmetic_tools.py	Documented arithmetic-tool tests.
tests/jax_tests/stim_extraction_tests.py	Documented Stim extraction tests.
tests/interface_tests/test_virtual_backend.py	Removed obsolete quote markers.
tests/interface_tests/test_stim_converter.py	Documented Stim-conversion tests.
tests/interface_tests/test_stim_backend.py	Converted license header to comments.
tests/interface_tests/test_qiskit_converter.py	Converted license header to comments.
tests/interface_tests/test_measurement_result.py	Converted license header to comments.
tests/interface_tests/test_job.py	Removed obsolete quote markers.
tests/interface_tests/test_iqm_backend.py	Converted license header to comments.
tests/interface_tests/test_default_backend.py	Converted license header to comments.
tests/interface_tests/test_batched_backend.py	Converted license header to comments.
tests/interface_tests/test_backend.py	Removed obsolete quote markers.
tests/interface_tests/conftest.py	Removed obsolete quote markers.
tests/core_tests/tests_doc_examples.py	Documented executable examples.
tests/core_tests/test_unitary_calculation.py	Documented unitary-calculation tests.
tests/core_tests/test_uncomputation_example.py	Documented uncomputation tests.
tests/core_tests/test_symbolic_statevector.py	Documented symbolic-statevector tests.
tests/core_tests/test_string_test.py	Documented QuantumString tests.
tests/core_tests/test_state_preparation.py	Documented state-preparation tests.
tests/core_tests/test_quantum_float.py	Documented QuantumFloat tests.
tests/core_tests/test_quantum_dictionary.py	Documented QuantumDictionary tests.
tests/core_tests/test_qompiler.py	Documented compiler tests.
tests/core_tests/test_outcome_array.py	Documented OutcomeArray tests.
tests/core_tests/test_measurement_reduction.py	Documented measurement-reduction tests.
tests/core_tests/test_loops.py	Documented quantum-loop tests.
tests/core_tests/test_iteration_environment.py	Documented iteration-environment tests.
tests/core_tests/test_injection.py	Documented injection tests.
tests/core_tests/test_hello_world.py	Documented introductory example tests.
tests/core_tests/test_GXX_converter_example.py	Documented GXX conversion tests.
tests/core_tests/test_gray_synthesis_example.py	Documented synthesis tests.
tests/core_tests/test_GMS_environment_example.py	Documented GMS environment tests.
tests/core_tests/test_depth_calculation.py	Documented depth-calculation tests.
tests/core_tests/test_custom_control.py	Documented custom-control tests.
tests/core_tests/test_controlled_gates.py	Documented controlled-gate tests.
tests/core_tests/test_conjugation_environment.py	Documented conjugation tests.
tests/core_tests/test_array_entry_manipulation.py	Documented array-entry tests.
tests/core_tests/test_abstract_parameters.py	Documented abstract-parameter tests.
tests/core_tests/test_abstr_params_printing.py	Documented parameter-printing tests.
tests/core_tests/quantum_array/test_arithmetic_validation.py	Documented arithmetic-validation tests.
tests/core_tests/quantum_array/__init__.py	Converted package license header.
tests/core_tests/mcx_tests/test_mcx.py	Documented MCX tests.
tests/core_tests/mcx_tests/test_jones_mcx.py	Documented Jones MCX tests.
tests/core_tests/mcx_tests/test_amy_mcx.py	Documented Amy MCX tests.
tests/circuit_tests/test_quantum_circuit.py	Converted license header to comments.
tests/circuit_tests/passes/test_visualize.py	Documented visualization-pass tests.
tests/circuit_tests/passes/test_remove_barriers.py	Documented barrier-removal tests.
tests/circuit_tests/passes/test_pass_manager.py	Documented pass-manager tests.
tests/circuit_tests/passes/test_decompose.py	Documented decomposition-pass tests.
tests/circuit_tests/passes/test_circuit_pass.py	Documented circuit-pass tests.
tests/circuit_tests/passes/test_cancel_zero_controls.py	Documented control-cancellation tests.
tests/circuit_tests/operation_tests/test_standard_operations.py	Converted license header to comments.
tests/block_encodings_tests/test_block_encoding.py	Documented BlockEncoding tests.
tests/block_encodings_tests/test_block_encoding_sim.py	Documented simulation-transformation tests.
tests/block_encodings_tests/test_block_encoding_pseudo_inv.py	Documented pseudoinverse tests.
tests/block_encodings_tests/test_block_encoding_poly.py	Documented polynomial-transformation tests.
tests/block_encodings_tests/test_block_encoding_inv.py	Documented inversion-transformation tests.
tests/block_encodings_tests/test_block_encoding_from_lcu.py	Documented LCU-construction tests.
tests/block_encodings_tests/test_block_encoding_arithmetic.py	Documented block-arithmetic tests.
tests/algorithms_tests/test_sudoku.py	Documented Sudoku tests.
tests/algorithms_tests/test_quantum_counting.py	Documented quantum-counting tests.
tests/algorithms_tests/test_QMCI.py	Documented QMCI tests.
tests/algorithms_tests/test_QIROMaxSat.py	Documented QIRO MaxSat tests.
tests/algorithms_tests/test_QIROmaxClique.py	Documented QIRO Max Clique tests.
tests/algorithms_tests/test_grovers_algorithm.py	Documented Grover tests.
tests/algorithms_tests/test_CKS.py	Documented CKS tests.
tests/algorithms_tests/test_backtracking.py	Documented backtracking tests.
tests/__init__.py	Converted package license header.
src/qrisp/simulator/__init__.py	Converted package license header.
src/qrisp/qtypes/__init__.py	Converted package license header.
src/qrisp/permeability/__init__.py	Converted package license header.
src/qrisp/operators/qubit/__init__.py	Converted package license header.
src/qrisp/operators/fermionic/__init__.py	Converted package license header.
src/qrisp/operators/__init__.py	Converted package license header.
src/qrisp/misc/__init__.py	Converted package license header.
src/qrisp/jasp/program_control/__init__.py	Converted package license header.
src/qrisp/jasp/mlir/__init__.py	Converted package license header.
src/qrisp/jasp/__init__.py	Converted package license header.
src/qrisp/interface/converter/__init__.py	Converted package license header.
src/qrisp/interface/__init__.py	Converted package license header.
src/qrisp/environments/__init__.py	Converted package license header.
src/qrisp/core/__init__.py	Converted package license header.
src/qrisp/circuit/__init__.py	Converted package license header.
src/qrisp/block_encodings/transformations/__init__.py	Converted package license header.
src/qrisp/block_encodings/__init__.py	Converted package license header.
src/qrisp/algorithms/grover/__init__.py	Converted package license header.
src/qrisp/algorithms/__init__.py	Converted package license header.
src/qrisp/alg_primitives/state_preparation/__init__.py	Converted package license header.
src/qrisp/alg_primitives/__init__.py	Converted package license header.
src/qrisp/__init__.py	Converted top-level package license header.
setup.py	Added packaging module documentation.
documentation/source/conf.py	Converted Sphinx configuration header.
documentation/source/_static/tsp_plot.py	Converted plotting-script header.
documentation/source/_static/torus_plot.py	Converted plotting-script header.
documentation/source/_static/qmci_plot.py	Converted plotting-script header.
documentation/source/_static/hamiltonian_plot.py	Converted plotting-script header.
documentation/source/_ext/tutorial_authors.py	Converted extension-module header.

Review details

• Files reviewed: 283/283 changed files
• Comments generated: 0
• Review effort level: Balanced

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.