Skip to content

Commit

Permalink
docs: fix syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
jokasimr committed Sep 20, 2024
1 parent 790ddd9 commit bff5cb3
Showing 1 changed file with 20 additions and 10 deletions.
30 changes: 20 additions & 10 deletions src/ess/reflectometry/tools.py
Original file line number Diff line number Diff line change
Expand Up @@ -187,14 +187,18 @@ def scale_reflectivity_curves_to_overlap(
All curves must be have the same unit for data and the Q-coordinate.
Parameters:
curves: the reflectivity curves that should be scaled together
return_scaling_factor:
If True the return value of the function
is a list of the scaling factors that should be applied.
If False (default) the function returns the scaled curves.
Parameters
---------
curves:
the reflectivity curves that should be scaled together
return_scaling_factor:
If True the return value of the function
is a list of the scaling factors that should be applied.
If False (default) the function returns the scaled curves.
Returns:
---------
:
A list of scaled reflectivity curves or a list of scaling factors.
'''
if len({c.data.unit for c in curves}) != 1:
Expand Down Expand Up @@ -242,10 +246,16 @@ def combine_curves(
All curves must be have the same unit for data and the Q-coordinate.
Parameters:
curves: the reflectivity curves that should be combined
qgrid: the Q-grid of the resulting combined reflectivity curve
Returns:
Parameters
----------
curves:
the reflectivity curves that should be combined
qgrid:
the Q-grid of the resulting combined reflectivity curve
Returns
---------
:
A data array representing the combined reflectivity curve
'''
if len({c.data.unit for c in curves}) != 1:
Expand Down

0 comments on commit bff5cb3

Please sign in to comment.