Skip to content

Sccarda/python docs update#3131

Open
ScottCarda-MS wants to merge 24 commits intomainfrom
sccarda/PythonDocsUpdate
Open

Sccarda/python docs update#3131
ScottCarda-MS wants to merge 24 commits intomainfrom
sccarda/PythonDocsUpdate

Conversation

@ScottCarda-MS
Copy link
Copy Markdown
Contributor

@ScottCarda-MS ScottCarda-MS commented Apr 17, 2026

This is a fairly large PR to over-hall the doc strings in the qsharp python 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:

  • While this PR does update and standardize some qdk package 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.
  • There are some structural changes to our API that are needed to make public some types and functions. Until this is done some doc references will be broken xref links. These are already present in our documentation. A future PR will be used to update our API to make the relevant content public and accessible to the doc-gen tool to fix these links.

@ScottCarda-MS ScottCarda-MS marked this pull request as ready for review April 17, 2026 23:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants