[Docs] Add source docstrings for QDP constructor and alias API entries#1404
Merged
Conversation
viiccwen
requested review from
400Ping,
guan404ming and
ryankert01
as code owners
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
2 participants
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.
Related Issues
Closes #1348
Changes
Why
QDP Python API reference content is generated from source docstrings. A few
public entries had no source-level documentation for constructor parameters or
alias intent, which left the generated API surface less clear than the source
code can support.
How
Added focused source documentation for:
QdpEngine.__init__, including constructor parameters and the unsupportedbackend error.
QuantumDataLoader.__init__, including default batching settings andvalidation behavior.
QuantumTensor, documenting it as a backward-compatible alias forQdpTensor.Checklist