Improve docstring of std_lattice of SpglibDataset#603
Merged
atztogo merged 1 commit intospglib:developfrom Nov 18, 2025
adrybakov:patch-1
Merged
Improve docstring of std_lattice of SpglibDataset#603atztogo merged 1 commit intospglib:developfrom adrybakov:patch-1
atztogo merged 1 commit intospglib:developfrom
adrybakov:patch-1
Conversation
Collaborator
|
@adrybakov, yes, it is true. Thanks! |
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
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.
Hello!
To my understanding of the spglib's documentation
SpglibDataset.std_latticeis an idealised standardised lattice.Here is an example to illustrate it
Code example
Code output
Visualisation of two cells from code example
As one can see the
dataset.std_latticeis an idealised one, according to docs.Proposed changes make this fact more clear in the docs.
Best,
Andrey