Skip to content

Commit

Permalink
fix docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
DanielYang59 committed Dec 24, 2024
1 parent b2d464b commit 3c31d3f
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions src/pymatgen/analysis/pourbaix_diagram.py
Original file line number Diff line number Diff line change
Expand Up @@ -773,10 +773,11 @@ def get_pourbaix_domains(
limits (list[list[float]]): limits in which to do the pourbaix
analysis
Returns: # TODO: incorrect return type doc
Returns a dict of the form {entry: [boundary_points]}.
The list of boundary points are the sides of the N-1
dim polytope bounding the allowable ph-V range of each entry.
Returns:
tuple[dict[PourbaixEntry, list], dict[PourbaixEntry, NDArray]:
The first dict is of form: {entry: [boundary_points]}.
The list of boundary points are the sides of the N-1
dim polytope bounding the allowable ph-V range of each entry.
"""
if limits is None:
limits = [[-2, 16], [-4, 4]]
Expand Down Expand Up @@ -813,8 +814,8 @@ def get_pourbaix_domains(
pourbaix_domains[this_entry].append(intersection)

# Remove entries with no Pourbaix region
pourbaix_domains = {k: v for k, v in pourbaix_domains.items() if v}
pourbaix_domain_vertices = {}
pourbaix_domains: dict[PourbaixEntry, list] = {k: v for k, v in pourbaix_domains.items() if v}
pourbaix_domain_vertices: dict[PourbaixEntry, NDArray] = {}

for entry, points in pourbaix_domains.items():
points = np.array(points)[:, :2]
Expand Down

0 comments on commit 3c31d3f

Please sign in to comment.