Skip to content

Commit f6abb24

Browse files
committed
Update docstrings of RFBucket.is_in_separatrix and RFBucket.make_is_accepted .
1 parent 65310c2 commit f6abb24

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

trackers/rf_bucket.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -262,13 +262,13 @@ def p_max(self, zc):
262262
return np.amax(f(self.zs))
263263

264264
def is_in_separatrix(self, z, dp):
265-
""" Returns boolean whether this coordinate is located strictly
266-
inside the separatrix. """
265+
""" Returns boolean whether the coordinate (z, dp) is located
266+
strictly inside the separatrix. """
267267
return np.logical_and(np.logical_and(self.zleft < z, z < self.zright),
268268
self.hamiltonian(z, dp) > 0)
269269

270270
def make_is_accepted(self, margin):
271-
""" Returns the function is_accepted(self, z, dp) definining the
271+
""" Returns the function is_accepted(z, dp) definining the
272272
equihamiltonian with a value of margin*self.Hmax . For margin 0,
273273
the returned is_accepted(z, dp) function is equivalent to
274274
self.is_in_separatrix(z, dp). """

0 commit comments

Comments
 (0)