Minor typo and formatting fixes for symmetries #486
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
ml-evs
changed the title
merkys
previously approved these changes
Jan 2, 2024
vaitkus
requested changes
Jan 3, 2024
merkys
previously approved these changes
Jan 4, 2024
vaitkus
requested changes
Jan 4, 2024
- Fix bulletpoint formatting
Co-authored-by: Antanas Vaitkus <[email protected]> - Apply suggestions from code review Co-authored-by: Antanas Vaitkus <[email protected]> - Update optimade.rst Co-authored-by: Antanas Vaitkus <[email protected]>
ml-evs
force-pushed
the
ml-evs/formatting-fixes
branch
from
5f38d43
to
77864b9
Compare
This was referenced Jan 4, 2024
merkys
previously approved these changes
Jan 4, 2024
vaitkus
previously approved these changes
Jan 4, 2024
ml-evs
force-pushed
the
ml-evs/formatting-fixes
branch
from
fb20e6e
to
0892136
Compare
merkys
approved these changes
Jan 4, 2024
Merged
rartino
reviewed
Jan 5, 2024
Comment on lines
-3750
to
+3745
| Symmetry operation strings that comprise the :property:`space_group_symmetry_operation_xyz` property MUST conform to the following regular expressions. | ||
| Symmetry operation strings that comprise the :property:`space\_group\_symmetry\_operations\_xyz` property MUST conform to the following regular expressions. |
There was a problem hiding this comment.
Is quoting underscores inside custom roles in rst necessary? This footnote leads me to think that it is not?: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#footnote-reference-3
Some testing does seem to suggest it doesn't really harm anything for custom roles, so I guess it is ok to do it. In literal context (double backticks) the backslashes are rendered.
There was a problem hiding this comment.
The main fix here was the typo in the field name, perhaps I was over cautious with the \...
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.
Just a few things that popped up whilst implementing the new symmetry operations.
I think it's better to rearrange the big block descriptions into the "Requirements/conventions" sections to follow how we do it with other fields (see the second commit here) but happy to roll that one back.