F and f used inconsistently in documention? #147
Merged
Conversation
This file contains 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
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
nikolasibalic
approved these changes
Sep 30, 2023
|
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)? |
|
Merging this as it is. Further improvements we can add in separate PRs |
|
Nothing else to add from my side. I left it as a draft because I wasn't sure which way you wanted to go. |
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.
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.