Skip to content

Conversation

@leburgel
Copy link
Member

@leburgel leburgel commented Oct 6, 2025

  • Adds explicit statement that σⁱ = 2 ⋅ Sⁱ to the docstrings of all the Pauli operator aliases, as well as a reference to the matching spin operator. The convention to obtain Pauli operators from spin operators was only mentioned in the manual page, making the Pauli operator docstrings quite useless by themselves.
  • Fixes mismatches in the docstrings of the Q-state Potts model where the method definition used a small q as a keyword argument while the docstring showed a capital Q keyword, as well as some math formatting.

@codecov
Copy link

codecov bot commented Oct 6, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

Files with missing lines Coverage Δ
src/operators/spinoperators.jl 92.22% <100.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@lkdvos lkdvos merged commit 750770a into master Oct 6, 2025
9 checks passed
@lkdvos lkdvos deleted the lb/docs_fixes branch October 6, 2025 11:29
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.

3 participants