Document behavior for type-II magnetic crystal structure#283
Merged
lan496 merged 1 commit intospglib:developfrom Jun 6, 2023
Merged
Document behavior for type-II magnetic crystal structure#283lan496 merged 1 commit intospglib:developfrom
lan496 merged 1 commit intospglib:developfrom
Conversation
Codecov ReportPatch and project coverage have no change.
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more. Additional details and impacted files@@ Coverage Diff @@
## develop #283 +/- ##
========================================
Coverage 85.92% 85.92%
========================================
Files 23 23
Lines 6081 6081
========================================
Hits 5225 5225
Misses 856 856
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR explicitly documents the breaking change of
get_symmetryfor a structure with zero magmoms between spglib v1 and v2.Although this point is mentioned in #150 (comment), it will be more decent to describe it in the document.
Also, this behavior (unexpectedly) seems to cause issues in other packages: for example, materialsproject/pymatgen#2725 and materialsproject/pymatgen#3006.
CC: @atztogo