fix(docs): Typo in ordering warning #396
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
In the documentation, there is a warning providing information regarding the ordering of the Fock basis states. However, it is wrong, since the ordering in the particle number conserving subspace is anti-lexicographic, instead of lexicographic. This has been corrected in this patch.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #396 +/- ##
=======================================
Coverage 97.35% 97.35%
=======================================
Files 72 72
Lines 3925 3925
=======================================
Hits 3821 3821
Misses 104 104 ☔ View full report in Codecov by Sentry. |
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.
In the documentation, there is a warning providing information regarding the ordering of the Fock basis states. However, it is wrong, since the ordering in the particle number conserving subspace is anti-lexicographic, instead of lexicographic. This has been corrected in this patch.