Sccarda/python docs update#3131
Merged
ScottCarda-MS merged 28 commits intomainfrom Apr 20, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR standardizes Python docstrings across the qsharp and qdk Python packages to use Sphinx/reST field-list syntax, improving the generated documentation output and hover help in editors.
Changes:
- Refactors module/class/function docstrings to Sphinx/reST format (
:param:,:return:,:rtype:,:raises:) acrossqsharpandqdk. - Clarifies and expands several public-facing docstrings (interop layers, estimator params types, noisy simulator stubs).
- Adds/updates small packaging hygiene items (e.g., new ignores in
.gitignore,__all__inqsharp.interop.qiskit).
Reviewed changes
Copilot reviewed 40 out of 41 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| source/qdk_package/src/qdk/simulation.py | Adds module-level Sphinx-style documentation for simulation utilities. |
| source/qdk_package/src/qdk/qsharp.py | Expands module docstring describing qdk.qsharp re-export behavior. |
| source/qdk_package/src/qdk/qiskit.py | Adjusts Sphinx cross-references in the Qiskit shim docstring. |
| source/qdk_package/src/qdk/openqasm.py | Expands module docstring describing OpenQASM re-export/shim behavior. |
| source/qdk_package/src/qdk/estimator.py | Expands module docstring describing estimator re-export/shim behavior. |
| source/qdk_package/src/qdk/cirq.py | Updates module docstring to describe re-export and installation extra. |
| source/qdk_package/src/qdk/azure/qiskit.py | Fixes example formatting to use reST literal block marker. |
| source/qdk_package/src/qdk/azure/cirq.py | Fixes example formatting to use reST literal block marker. |
| source/qdk_package/src/qdk/azure/init.py | Updates docstring formatting and adds a clearer usage example block. |
| source/qdk_package/src/qdk/init.py | Rewrites top-level package docstring into reST-friendly bullets. |
| source/pip/qsharp/utils/_utils.py | Standardizes return documentation (:return:/:rtype:). |
| source/pip/qsharp/openqasm/_run.py | Converts to Sphinx field-list docstring and clarifies kwargs/options. |
| source/pip/qsharp/openqasm/_import.py | Converts docstring to Sphinx field-list syntax and clarifies kwargs. |
| source/pip/qsharp/openqasm/_estimate.py | Converts docstring to Sphinx field-list syntax and clarifies kwargs. |
| source/pip/qsharp/openqasm/_compile.py | Converts docstring to Sphinx field-list syntax; minor formatting tweaks. |
| source/pip/qsharp/openqasm/_circuit.py | Converts docstring to Sphinx field-list syntax and documents new options. |
| source/pip/qsharp/noisy_simulator/_noisy_simulator.pyi | Updates stub docstrings to Sphinx field-list style. |
| source/pip/qsharp/interop/qiskit/jobs/qsjobset.py | Adds/standardizes class and method docstrings in Sphinx style. |
| source/pip/qsharp/interop/qiskit/jobs/qsjob.py | Adds/standardizes class/method docstrings; improves constructor docs. |
| source/pip/qsharp/interop/qiskit/backends/re_backend.py | Renames kwargs plumbing (**options) and standardizes docstrings. |
| source/pip/qsharp/interop/qiskit/backends/qsharp_backend.py | Renames kwargs plumbing (**options) and standardizes docstrings. |
| source/pip/qsharp/interop/qiskit/backends/qirtarget.py | Converts docstrings to Sphinx field-list syntax. |
| source/pip/qsharp/interop/qiskit/backends/neutral_atom_target.py | Converts docstrings to Sphinx field-list syntax. |
| source/pip/qsharp/interop/qiskit/backends/neutral_atom_backend.py | Standardizes backend docstrings and kwargs naming (**options). |
| source/pip/qsharp/interop/qiskit/backends/backend_base.py | Updates base backend docstrings to Sphinx field-list syntax. |
| source/pip/qsharp/interop/qiskit/init.py | Updates package docstring, improves xrefs, and defines __all__. |
| source/pip/qsharp/interop/cirq/_result.py | Converts function/class docs to Sphinx field-list syntax. |
| source/pip/qsharp/interop/cirq/_neutral_atom.py | Converts docs to Sphinx style and reformats a long expression. |
| source/pip/qsharp/interop/cirq/init.py | Adjusts module docstring formatting and exports list. |
| source/pip/qsharp/interop/init.py | Adds a brief module docstring for the interop package. |
| source/pip/qsharp/estimator/_estimator.py | Adds/expands estimator parameter docstrings throughout. |
| source/pip/qsharp/_simulation.py | Converts run_qir docstring to Sphinx field-list style. |
| source/pip/qsharp/_qsharp.py | Adds/updates docstrings across API surface for Sphinx generation. |
| source/pip/qsharp/_native.pyi | Updates stub docstrings to Sphinx style (notes, params, returns). |
| source/pip/qsharp/_http.py | Converts docstring to Sphinx field-list style. |
| source/pip/qsharp/_fs.py | Converts filesystem helper docstrings to Sphinx field-list style. |
| source/pip/qsharp/_device/_device.py | Converts device API docstrings to Sphinx field-list style. |
| source/pip/qsharp/_device/_atom/_scheduler.py | Refactors docstrings from “Attributes/Args” to reST paragraphs/fields. |
| source/pip/qsharp/_device/_atom/init.py | Standardizes return docstring field (:return:). |
| source/pip/qsharp/_adaptive_pass.py | Converts run docstring to Sphinx field-list style. |
| .gitignore | Ignores generated Python doc output directories. |
minestarks
reviewed
Apr 20, 2026
minestarks
reviewed
Apr 20, 2026
minestarks
approved these changes
Apr 20, 2026
jlehnersd
reviewed
Apr 20, 2026
Co-authored-by: Copilot <[email protected]>
…ft/qdk into sccarda/PythonDocsUpdate
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is a fairly large PR to over-hall the doc strings in the
qsharppython package. This standardizes the doc string format to use the Sphynx syntax recognized by our documentation-generating/publishing pipeline.Since this is a large refactoring, I recommend reviewing the changes via commit. The some commits that add new documentation content are:
You can also take a look at the preview of the generated docs here:
https://review.learn.microsoft.com/en-us/python/qsharp/qsharp?view=qsharp-py&branch=pr-en-us-105
Notes:
qdkpackage doc strings, the package as a whole is not yet ready for generated documentation pages. Updating these doc strings in code is still useful as these doc strings appear on hover in development.