Skip to content

Commit e92392c

Browse files
committedJul 31, 2024·
fix: solve function docstring signature
1 parent b622feb commit e92392c

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed
 

‎docs/notebooks/tutorials/analytical-ir.ipynb

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187
"metadata": {},
188188
"source": [
189189
"```{note}\n",
190-
"The [core.solve](nuance.core.solve) function returns a function that computes the depth of a transt given its epoch and duration, it has the signature `function(epoch, duration, period=None, depth=None) -> (log_likelihood, weights, variance)`. When the `depth` parameter is set, the function computes the depth of a transit **injected** with this `depth`. Usually `depth=None`, as this feature is only useful for injection-recovery estimates.\n",
190+
"The [core.solve](nuance.core.solve) function returns a function that computes the depth of a transt given its epoch and duration, it has the signature `function(epoch, duration, period=None, depth=None) -> (depth, depth_variance, log_likelihood)`. When the `depth` parameter is set, the function computes the depth of a transit **injected** with this `depth`. Usually `depth=None`, as this feature is only useful for injection-recovery estimates.\n",
191191
"```"
192192
]
193193
},

‎nuance/core.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ def solve(time, flux, gp=None, X=None, model=None):
115115
callable
116116
function that computes the log likelihood of data assuming it is drawn from a
117117
Gaussian Process with a mean linear model. Signature is:
118-
:code:`function(epoch, duration, period=None) -> (log_likelihood, weights, variance)`
118+
``function(epoch, duration, period=None) -> (depth, depth_variance, log_likelihood)``
119119
"""
120120

121121
X, gp, model = check_default(time, X, gp, model)

0 commit comments

Comments
 (0)
Please sign in to comment.