From 2f9063e8bf0566d170d72915ee2b7d29efb4818c Mon Sep 17 00:00:00 2001 From: VsevolodX <79542055+VsevolodX@users.noreply.github.com> Date: Wed, 19 Jun 2024 20:56:14 -0700 Subject: [PATCH] chore: cleanup docstrings --- src/py/mat3ra/made/basis/basis.py | 1 - src/py/mat3ra/made/tools/material.py | 13 ++++++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/src/py/mat3ra/made/basis/basis.py b/src/py/mat3ra/made/basis/basis.py index 0bec7a53..b3508f27 100644 --- a/src/py/mat3ra/made/basis/basis.py +++ b/src/py/mat3ra/made/basis/basis.py @@ -14,7 +14,6 @@ class Basis(RoundNumericValuesMixin, BaseModel): coordinates: ArrayWithIds = ArrayWithIds(values=[0, 0, 0]) units: str = AtomicCoordinateUnits.crystal cell: Optional[Cell] = None - # TODO: isolate labels to a separate class labels: Optional[ArrayWithIds] = ArrayWithIds(values=[]) constraints: Optional[ArrayWithIds] = ArrayWithIds(values=[]) diff --git a/src/py/mat3ra/made/tools/material.py b/src/py/mat3ra/made/tools/material.py index a982c4b2..cd5376c3 100644 --- a/src/py/mat3ra/made/tools/material.py +++ b/src/py/mat3ra/made/tools/material.py @@ -4,10 +4,12 @@ def scale_one_lattice_vector(material, key="a", factor=1.0): """ - Scales one lattice vector for the given material. - :param material: The material acted upon. - :param key: Lattice vector key. - :param factor: Float scaling factor. + Scales one lattice vector for the given material in place. + + Args: + material: The material to scale. + key: The key of the lattice vector to scale. + factor: The factor to scale the lattice vector by """ material.to_cartesian() @@ -23,7 +25,8 @@ def get_basis_config_translated_to_center(material): """ Updates the basis of a material by translating the coordinates so that the center of the material and lattice are aligned. - :param material: The material to update. + Args: + material: The material to update. """ original_units = material.basis.units material.to_cartesian()