Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix parent of imported category #62

Merged
merged 3 commits into from
Jan 23, 2024

Conversation

vaitkus
Copy link
Collaborator

@vaitkus vaitkus commented Jan 19, 2024

This PR changes the parent category of the ATOM_SITE_FOURIER_WAVE_VECTOR category from MS_GROUP to MAGNETIC. After the change in the parent category, the ATOM_SITE_FOURIER_WAVE_VECTOR had to be moved to adhere to the dictionary style guide child category ordering rules.

The ATOM_SITE_FOURIER_WAVE_VECTOR category is originally defined in the CIF_MS dictionary and expanded/overwritten in this dictionary. However, since the CIF_MS dictionary is imported in full (head-in-head import), all top level categories from the CIF_MS dictionary become automatically reparented from MS_GROUP to MAGNETIC. Furthermore, the MS_GROUP head category is not imported at all, thus resulting in a missing parent category.

Since the CIF_MS dictionary is imported in full (head-in-head import),
all top level categories from the CIF_MS dictionary become automatically
reparented from MS_GROUP to MAGNETIC. Furthermore, the MS_GROUP head category
is not imported at all, thus resulting in a missing parent category.
@brantonc
Copy link
Collaborator

brantonc commented Jan 20, 2024 via email

@jamesrhester jamesrhester merged commit 9d05150 into COMCIFS:main Jan 23, 2024
2 checks passed
@jamesrhester
Copy link
Contributor

jamesrhester commented Jan 23, 2024

I've merged this in, it is purely a technical issue.

Just to explain further, the ATOM_SITE_FOURIER_WAVE_VECTOR category is fully defined in the modulated structures dictionary, and the magnetic dictionary repeats that definition so it can include more examples. Meanwhile, technically speaking, the magnetic structures dictionary views everything found in the modulated structures dictionary as magnetic dictionary definitions. Thus this repeated category, even though it is defined originally in the modulated structures dictionary, should be specified here as belonging to the magnetic dictionary, as that is what all of its modulated structures dictionary definitions end up being. It is a one-line change ultimately.

@vaitkus vaitkus deleted the fix-parent-of-imported-category branch January 23, 2024 05:54
@brantonc
Copy link
Collaborator

brantonc commented Jan 24, 2024 via email

@jamesrhester
Copy link
Contributor

I've already made the single, tiny change. On line 55 of https://github.com/COMCIFS/magnetic_dic/blob/main/cif_mag.dic (which is the latest version), line 55 has been changed from MS_GROUP to MAGNETIC. All items in the ATOM_SITE_FOURIER_WAVE_VECTOR category have moved to an earlier location in the file to match our ordering style guide, but the actual contents have not changed except for that single change at current line 55.

If you have any objections to this we can make another PR.

@brantonc
Copy link
Collaborator

brantonc commented Jan 24, 2024 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants