Skip to content

Commit

Permalink
correction of documentation
Browse files Browse the repository at this point in the history
order of energies  (which energy is substracted from which) was flipped 
in description of code in documentation, which could cause unexpected 
extra minus sign.
  • Loading branch information
nikolasibalic committed Nov 5, 2018
1 parent d6f07d4 commit e1932c6
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions arc/alkali_atom_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -1112,8 +1112,8 @@ def getEnergyDefect(self,n,l,j,n1,l1,j1,n2,l2,j2):
Energy defect for the given two pair-states (one of the state has
two atoms in the same state)
Energy difference between the states :math:`E(n,l,j,n,l,j) - \
E(n_1,l_1,j_1,n_2,l_2,j_2)`
Energy difference between the states
:math:`E(n_1,l_1,j_1,n_2,l_2,j_2) - E(n,l,j,n,l,j)`
Args:
n (int): principal quantum number
Expand All @@ -1136,8 +1136,8 @@ def getEnergyDefect2(self,n,l,j,nn,ll,jj,n1,l1,j1,n2,l2,j2):
"""
Energy defect for the given two pair-states
Energy difference between the states :math:`E(n,l,j,nn,ll,jj) - \
E(n_1,l_1,j_1,n_2,l_2,j_2)`
Energy difference between the states
:math:`E(n_1,l_1,j_1,n_2,l_2,j_2) - E(n,l,j,nn,ll,jj)`
See `pair-state energy defects example snippet`_.
Expand Down

0 comments on commit e1932c6

Please sign in to comment.