Skip to content

Commit 2319e85

Browse files
ablaomOkonSamuel
andauthored
tweak docstring
Co-authored-by: Okon Samuel <[email protected]>
1 parent 82aa20a commit 2319e85

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

src/model_api.jl

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -208,10 +208,11 @@ supports reporting.
208208
Overloading this method is optional, unless the model generates reports that are neither
209209
named tuples nor `nothing`.
210210
211-
Assuming each dictionary value is a named tuple or `nothing`, the fallback returns the
212-
usual named tuple merge of the dictionary values, ignoring any `nothing` values, and
213-
assuming there are no conflicts between the keys of the dictionary values (the individual
214-
reports). If there is a key conflict, all operation reports are first wrapped in a named
211+
Assuming each value in the `report_given_method` dictionary is either a named tuple
212+
or `nothing`, and there are no conflicts between the keys of the dictionary values
213+
(the individual reports), the fallback returns the usual named tuple merge of the
214+
dictionary values, ignoring any `nothing` value. If there is a key conflict, all operation
215+
reports are first wrapped in a named
215216
tuple of length one, as in `(predict=predict_report,)`. A `:fit` report is never wrapped.
216217
217218
If any dictionary `value` is neither a named tuple nor `nothing`, it is first wrapped as

0 commit comments

Comments
 (0)