Skip to content

Commit

Permalink
Docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
Sam-Bouten committed Nov 15, 2021
1 parent ed69517 commit 48af8aa
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/compas_fd/solvers/solver.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ def __init__(self,
self.result = None

def __call__(self) -> Result:
"""Iteratively apply the solve algorithm."""
"""Iteratively apply the solver algorithm."""
for self.kcount in range(1, self.kmax + 1):
self.solve()
if self.is_converged:
Expand All @@ -28,12 +28,12 @@ def __call__(self) -> Result:
return self.result

def solve(self) -> None:
"""Apply solver algorithm for a single iteration."""
"""Apply the solver algorithm for a single iteration."""
raise NotImplementedError

@property
def is_converged(self) -> bool:
"""Verify if all convergence criteria are met."""
"""Verify if convergence criteria are met."""
raise NotImplementedError

def post_process(self) -> None:
Expand Down

0 comments on commit 48af8aa

Please sign in to comment.