Skip to content

topology.unwrap() documentation incorrect #17

@svarner9

Description

@svarner9

The function for unwrapping coordinates states that in_place=False by default, but after inspecting the source code, the function shows in_place=True.

in_place : `bool`, keyword-only, default: :code:`False`
    Determines whether the input array is modified in-place.
def unwrap(
    positions: np.ndarray[float],
    positions_old: np.ndarray[float],
    dimensions: np.ndarray[float],
    *,
    thresholds: float = None,
    images: np.ndarray[int] = None,
    in_place: bool = True,
)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions