Fix docstrings for HamIsing and HamRG classes#181
Open
Parth-Garg2629 wants to merge 1 commit intotheochem:mainfrom
Open
Fix docstrings for HamIsing and HamRG classes#181Parth-Garg2629 wants to merge 1 commit intotheochem:mainfrom
Parth-Garg2629 wants to merge 1 commit intotheochem:mainfrom
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.
Description
This PR fixes a minor documentation bug in the HamIsing and HamRG classes where the init docstrings were incorrectly copied from the HamHeisenberg base class.
Changes made:
"Initialize Ising Hamiltonian."instead of"Initialize XXZ Heisenberg Hamiltonian.""Initialize Richardson-Gaudin Hamiltonian."instead of"Initialize XXZ Heisenberg Hamiltonian."Type of change
How Has This Been Tested?
This is a documentation-only update. No code logic was modified. Existing tests can be verified using
pytest moha/test/test_Heisenberg.py.