Open
Conversation
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.