Skip to content

Commit 13f227d

Browse files
docs: improve docstring
1 parent 0a155aa commit 13f227d

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/diffpy/utils/diffraction_objects.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -408,22 +408,22 @@ def scale_to(self, target_diff_object, q=None, tth=None, d=None, offset=None):
408408
Parameters
409409
----------
410410
target_diff_object: DiffractionObject
411-
the diffraction object you want to scale the current one onto
411+
The diffraction object you want to scale the current one onto.
412412
413-
q, tth, d : float, optional, default is the max q-value from each object
413+
q, tth, d : float, optional, default is None
414414
The value of the x-array where you want the curves to line up vertically.
415415
Specify a value on one of the allowed grids, q, tth, or d), e.g., q=10.
416416
417417
offset : float, optional, default is None
418-
an offset to add to the scaled y-values
418+
The offset to add to the scaled y-values.
419419
420420
Returns
421421
-------
422-
the rescaled DiffractionObject as a new object
422+
scaled : DiffractionObject
423+
The rescaled DiffractionObject as a new object.
423424
"""
424425
if offset is None:
425426
offset = 0
426-
427427
scaled = self.copy()
428428
count = sum([q is not None, tth is not None, d is not None])
429429
if count > 1:

0 commit comments

Comments
 (0)