Docs: Python Structure constructor wrong units#501
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Corrects the Python Structure constructor docstring to reflect that coordinates are in Bohr, not Angstrom, matching the underlying C++ implementation.
Changes:
- Fix unit annotation in
Structure.__init__docstring (Angstrom → Bohr).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
📊 Coverage Summary
Detailed Coverage ReportsC++ Coverage DetailsPython Coverage DetailsPybind11 Coverage Details |
wavefunction91
approved these changes
Jun 2, 2026
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.
Currently the Python API docs show that Structure constructor takes coordinates as angstrom (https://microsoft.github.io/qdk-chemistry/api/api_autogen/qdk_chemistry.data.html#qdk_chemistry.data.Structure.__init__) but this is not true.