Skip to content

Commit 0048737

Browse files
committed
MNT: improve docstrings according to code reviews.
1 parent fe7bad3 commit 0048737

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

rocketpy/simulation/monte_carlo.py

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,9 @@ def __init__(
123123
Path to the batch folder to be used in the simulation. Export file
124124
will be saved in this folder. Default is None.
125125
export_sample_time : float, optional
126-
Sample time to downsample the arrays in seconds. Default is 0.1.
126+
Sample time to downsample the arrays in seconds. Used to automatically
127+
discretize inputs that contain callable ``rocketpy.Function`` objects.
128+
Default is 0.1.
127129
128130
Returns
129131
-------
@@ -196,8 +198,9 @@ def simulate(
196198
parallel : bool, optional
197199
If True, the simulations will be run in parallel. Default is False.
198200
n_workers : int, optional
199-
Number of workers to be used. If None, the number of workers
200-
will be equal to the number of CPUs available. Default is None.
201+
Number of workers to be used if ``parallel=True``. If None, the
202+
number of workers will be equal to the number of CPUs available.
203+
Default is None.
201204
202205
Returns
203206
-------
@@ -1191,6 +1194,10 @@ def prepare_export_data(obj, sample_time=0.1, remove_functions=False):
11911194
----------
11921195
obj : object
11931196
The object whose attributes are to be inspected.
1197+
sample_time : float, optional
1198+
Time interval between samples. Default is 0.1.
1199+
remove_functions : bool, optional
1200+
If True, the Function objects will not be serialized. Default is False.
11941201
11951202
Returns
11961203
-------

0 commit comments

Comments
 (0)