Skip to content

Commit

Permalink
tweak doc strings
Browse files Browse the repository at this point in the history
  • Loading branch information
janosh committed Jul 31, 2023
1 parent 94f4413 commit 2ffd3bb
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions pymatgen/core/structure.py
Original file line number Diff line number Diff line change
Expand Up @@ -222,8 +222,8 @@ def get_distance(self, i: int, j: int) -> float:
Returns distance between sites at index i and j.
Args:
i: Index of first site
j: Index of second site
i: 1st site index
j: 2nd site index
Returns:
Distance between sites at index i and index j.
Expand Down Expand Up @@ -396,9 +396,9 @@ def get_angle(self, i: int, j: int, k: int) -> float:
Returns angle specified by three sites.
Args:
i: Index of first site.
j: Index of second site.
k: Index of third site.
i: 1st site index
j: 2nd site index
k: 3rd site index
Returns:
Angle in degrees.
Expand All @@ -412,10 +412,10 @@ def get_dihedral(self, i: int, j: int, k: int, l: int) -> float: # noqa: E741
Returns dihedral angle specified by four sites.
Args:
i: Index of first site
j: Index of second site
k: Index of third site
l: Index of fourth site
i: 1st site index
j: 2nd site index
k: 3rd site index
l: 4th site index
Returns:
Dihedral angle in degrees.
Expand Down Expand Up @@ -1368,8 +1368,8 @@ def get_distance(self, i: int, j: int, jimage=None) -> float:
atom and the specified jimage atom.
Args:
i (int): Index of first site
j (int): Index of second site
i (int): 1st site index
j (int): 2nd site index
jimage: Number of lattice translations in each lattice direction.
Default is None for nearest image.
Expand Down Expand Up @@ -3042,8 +3042,8 @@ def break_bond(self, ind1: int, ind2: int, tol: float = 0.2) -> tuple[IMolecule
ind1 and ind2.
Args:
ind1 (int): Index of first site.
ind2 (int): Index of second site.
ind1 (int): 1st site index
ind2 (int): 2nd site index
tol (float): Relative tolerance to test. Basically, the code
checks if the distance between the sites is less than (1 +
tol) * typical bond distances. Defaults to 0.2, i.e.,
Expand Down Expand Up @@ -3203,8 +3203,8 @@ def get_distance(self, i: int, j: int) -> float:
Get distance between site i and j.
Args:
i (int): Index of first site
j (int): Index of second site
i (int): 1st site index
j (int): 2nd site index
Returns:
Distance between the two sites.
Expand Down Expand Up @@ -3770,7 +3770,7 @@ def replace(
occupations.
Args:
idx (int): Index of the site in the _sites list.
idx (int): Index of the site in the sites list.
species (species-like): Species of replacement site
coords (3x1 array): Coordinates of replacement site. If None,
the current coordinates are assumed.
Expand Down

0 comments on commit 2ffd3bb

Please sign in to comment.