Skip to content

typo in 'core/structure.py' #4286

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

Closed
MoseyQAQ opened this issue Feb 11, 2025 · 1 comment · Fixed by #4290
Closed

typo in 'core/structure.py' #4286

MoseyQAQ opened this issue Feb 11, 2025 · 1 comment · Fixed by #4290

Comments

@MoseyQAQ
Copy link

Hi, I noticed a small typo in the comment in core/structure.py. The comment mentions "translation," but the function actually implements a "rotation" operation. (See line 4677 & 5298)

def rotate_sites(
self,
indices: Sequence[int] | None = None,
theta: float = 0.0,
axis: ArrayLike | None = None,
anchor: ArrayLike | None = None,
) -> Self:
"""Rotate specific sites by some angle around vector at anchor.
Args:
indices (list): List of site indices on which to perform the
translation.
theta (float): Angle in radians

def rotate_sites(
self,
indices: list[int] | None = None,
theta: float = 0.0,
axis: ArrayLike | None = None,
anchor: ArrayLike | None = None,
to_unit_cell: bool = True,
) -> Self:
"""Rotate specific sites by some angle around vector at anchor. Modifies
the structure in place.
Args:
indices (list): List of site indices on which to perform the
translation.
theta (float): Angle in radians

@DanielYang59
Copy link
Contributor

Thanks for catching this, I would fix it!

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 a pull request may close this issue.

2 participants