Skip to content

Commit f9dd9b2

Browse files
committed
Correcting typo in newest docstring
"descriving" -> "describing" And giving a bit more detail on the definitions of response function angles.
1 parent 407559b commit f9dd9b2

2 files changed

Lines changed: 16 additions & 12 deletions

File tree

docs/riroriro/detectabilityfuns.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,15 @@ alignment, specified by four angles as in Finn (1996), Belczynski et al.
6969
Parameters
7070
----------
7171
theta: float
72-
One of the angles descriving the direction of the line of sight to the
73-
gravitational wave source relative to the axes of the detector’s arms
74-
(sky-location coordinates). Ranges from 0 to π/2 rad (90 deg).
72+
The ecliptic latitude, one of the angles describing the direction of
73+
the line of sight to the gravitational wave source relative to the axes
74+
of the detector’s arms (sky-location coordinates of the binary). Ranges
75+
from 0 to π/2 rad (90 deg).
7576
phi: float
76-
One of the angles descriving the direction of the line of sight to the
77-
gravitational wave source relative to the axes of the detector’s arms
78-
(sky-location coordinates). Ranges from 0 to 2π rad (360 deg).
77+
The ecliptic longitude, one of the angles describing the direction of
78+
the line of sight to the gravitational wave source relative to the axes
79+
of the detector’s arms (sky-location coordinates of the binary). Ranges
80+
from 0 to 2π rad (360 deg).
7981
iota: float
8082
The inclination angle of the binary. Ranges from 0 to π/2 rad (90 deg).
8183
psi: float

riroriro/detectabilityfuns.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -129,13 +129,15 @@ def specific_orientation_SNR(theta,phi,iota,psi,SNR_in,angle_unit='rad'):
129129
Parameters
130130
----------
131131
theta: float
132-
One of the angles descriving the direction of the line of sight to the
133-
gravitational wave source relative to the axes of the detector’s arms
134-
(sky-location coordinates). Ranges from 0 to π/2 rad (90 deg).
132+
The ecliptic latitude, one of the angles describing the direction of
133+
the line of sight to the gravitational wave source relative to the axes
134+
of the detector’s arms (sky-location coordinates of the binary). Ranges
135+
from 0 to π/2 rad (90 deg).
135136
phi: float
136-
One of the angles descriving the direction of the line of sight to the
137-
gravitational wave source relative to the axes of the detector’s arms
138-
(sky-location coordinates). Ranges from 0 to 2π rad (360 deg).
137+
The ecliptic longitude, one of the angles describing the direction of
138+
the line of sight to the gravitational wave source relative to the axes
139+
of the detector’s arms (sky-location coordinates of the binary). Ranges
140+
from 0 to 2π rad (360 deg).
139141
iota: float
140142
The inclination angle of the binary. Ranges from 0 to π/2 rad (90 deg).
141143
psi: float

0 commit comments

Comments
 (0)