Skip to content

Commit 1d5ce45

Browse files
committed
review fixes to docstrings
1 parent f300e9c commit 1d5ce45

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

RATapi/inputs.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -484,19 +484,19 @@ def check_indices(problem: ProblemDefinition) -> None:
484484

485485

486486
def append_data_background(data: np.array, background: np.array) -> np.array:
487-
"""Add background data to contrast data.
487+
"""Append background data to contrast data.
488488
489489
Parameters
490490
----------
491491
data : np.array
492-
The contrast data to which we are adding a background.
492+
The contrast data to which we are appending a background.
493493
background : np.array
494-
The background data to add to the contrast.
494+
The background data to append to the contrast.
495495
496496
Returns
497497
-------
498498
np.array
499-
The contrast data with background data added as two additional columns.
499+
The contrast data with background data appended as two additional columns.
500500
501501
"""
502502
if not np.allclose(data[:, 0], background[:, 0]):

RATapi/models.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ def __str__(self):
258258

259259

260260
class CustomFile(RATModel):
261-
"""A file containing functions to use for a custom model, function background or function resolution.
261+
"""A file containing functions to use for a custom model or function background.
262262
263263
Parameters
264264
----------

0 commit comments

Comments
 (0)