Skip to content

Commit

Permalink
correct typos in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jhdark committed Jan 15, 2025
1 parent 2c389e4 commit e3da07f
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion festim/exports/derived_quantities/total_surface.py
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ class TotalSurfaceSpherical(TotalSurface):
field (str, int): the field ("solute", 0, 1, "T", "retention")
surface (int): the surface id
azimuth_range (tuple, optional): Range of the azimuthal angle
(theta) needs to be between 0 and 2 pi. Defaults to (0, 2 * np.pi)
(phi) needs to be between 0 and 2 pi. Defaults to (0, 2 * np.pi)
polar_range (tuple, optional): Range of the polar angle
(theta) needs to be between 0 and pi. Defaults to (0, np.pi).
Expand Down
4 changes: 2 additions & 2 deletions festim/exports/derived_quantities/total_volume.py
Original file line number Diff line number Diff line change
Expand Up @@ -146,9 +146,9 @@ class TotalVolumeSpherical(TotalVolume):
field (str, int): the field ("solute", 0, 1, "T", "retention")
volume (int): the volume id
azimuth_range (tuple, optional): Range of the azimuthal angle
(theta) needs to be between 0 and 2 pi. Defaults to (0, 2 * np.pi)
(phi) needs to be between 0 and 2 pi. Defaults to (0, 2 * np.pi)
polar_range (tuple, optional): Range of the polar angle
(theta) needs to be between - pi and pi. Defaults to (-np.pi, np.pi).
(theta) needs to be between 0 and pi. Defaults to (0, np.pi).
Attributes:
field (str, int): the field ("solute", 0, 1, "T", "retention")
Expand Down

0 comments on commit e3da07f

Please sign in to comment.