Skip to content

Commit

Permalink
docstring mods wfs.py in td/fd follow up #168
Browse files Browse the repository at this point in the history
  • Loading branch information
Frank Schultz committed Jan 21, 2021
1 parent efdda38 commit e25a708
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion sfs/fd/wfs.py
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ def point_25d(omega, x0, n0, xs, xref=[0, 0, 0], c=None, omalias=None):
Sequence of normal vectors of secondary sources.
xs : (3,) array_like
Position of virtual point source.
xref : (3,) array_like, optional
xref : (N, 3) array_like or (3,) array_like
Reference point xref or contour xref(x0) for amplitude correct
synthesis.
c : float, optional
Expand Down
6 changes: 3 additions & 3 deletions sfs/td/wfs.py
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ def plane_25d(x0, n0, n=[0, 1, 0], xref=[0, 0, 0], c=None):
def point_25d(x0, n0, xs, xref=[0, 0, 0], c=None):
r"""Driving function for 2.5-dimensional WFS of a virtual point source.
.. versionchanged:: 0.61
.. versionchanged:: >0.6.0
see notes, old handling of `point_25d()` is now `point_25d_legacy()`
Parameters
Expand All @@ -140,7 +140,7 @@ def point_25d(x0, n0, xs, xref=[0, 0, 0], c=None):
xs : (3,) array_like
Virtual source position.
xref : (N, 3) array_like or (3,) array_like
Reference curve of correct amplitude xref(x0)
Reference point xref or contour xref(x0) for amplitude correct synthesis.
c : float, optional
Speed of sound
Expand Down Expand Up @@ -217,7 +217,7 @@ def point_25d(x0, n0, xs, xref=[0, 0, 0], c=None):
def point_25d_legacy(x0, n0, xs, xref=[0, 0, 0], c=None):
r"""Driving function for 2.5-dimensional WFS of a virtual point source.
.. versionadded:: 0.61
.. versionadded:: >0.6.0
`point_25d()` was renamed to `point_25d_legacy()` (and a new
function with the name `point_25d()` was introduced). See notes below
for further details.
Expand Down

0 comments on commit e25a708

Please sign in to comment.