search

nikolasibalic / ARC-Alkali-Rydberg-Calculator

Object-oriented Python library for computation of properties of highly-excited Rydbeg states of alkali and divalent atoms.
https://atomcalc.org
BSD 3-Clause "New" or "Revised" License
86 stars 72 forks source link

F and f used inconsistently in documention? #147

Closed petermao closed 9 months ago

petermao commented 1 year ago

also "n1." leads to parsing error in online documentation.

see https://arc-alkali-rydberg-calculator.readthedocs.io/en/latest/generated/arc.alkali_atom_functions.AlkaliAtom.getDipoleMatrixElementHFS.html#arc.alkali_atom_functions.AlkaliAtom.getDipoleMatrixElementHFS

Alternatively, we use "F" throughout in the documentation to be consistent with published notation, but then the code still uses "f" for I+S.

Sorry -- I meant to push this branch to my own fork and start the PR from there. I didn't realize I had write access here.

nikolasibalic commented 9 months ago

Thank you for this correction @petermao !

From my side it's fine to merge this to main. Is there anything else you want to add (I see it is still marked as draft)?

nikolasibalic commented 9 months ago

Merging this as it is. Further improvements we can add in separate PRs

petermao commented 9 months ago

Nothing else to add from my side. I left it as a draft because I wasn't sure which way you wanted to go.