Skip to content

typo in 'core/structure.py' #4286

@MoseyQAQ

Description

@MoseyQAQ

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions