Skip to content

Fix docstrings for HamIsing and HamRG classes#181

Open
Parth-Garg2629 wants to merge 1 commit intotheochem:mainfrom
Parth-Garg2629:fix-ising-rg-docstrings
Open

Fix docstrings for HamIsing and HamRG classes#181
Parth-Garg2629 wants to merge 1 commit intotheochem:mainfrom
Parth-Garg2629:fix-ising-rg-docstrings

Conversation

@Parth-Garg2629
Copy link

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:

  • Updated the [init] docstring in [HamIsing] to state "Initialize Ising Hamiltonian." instead of "Initialize XXZ Heisenberg Hamiltonian."
  • Updated the [init] docstring in [HamRG] to state "Initialize Richardson-Gaudin Hamiltonian." instead of "Initialize XXZ Heisenberg Hamiltonian."
  • Expanded the class docstring for the base [HamHeisenberg] to include the mathematical formulation of the XXZ Hamiltonian and explicitly mention its relation to the [HamIsing] and [HamRG] subclasses for better clarity.

Type of change

  • Documentation update

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.

@PaulWAyers PaulWAyers requested a review from RichRick1 March 5, 2026 15:18
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.

1 participant