Skip to content

Commit

Permalink
Small correction in the io.write_list_of_observations docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
sgiardie committed Dec 7, 2021
1 parent 1ef63ca commit c12b58f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions litebird_sim/io.py
Original file line number Diff line number Diff line change
Expand Up @@ -216,22 +216,22 @@ def write_list_of_observations(
- ``local_index``: the number of the current observation within the current
MPI process (see below)
You can provide other placeholders through `custom_dicts`, which must be
You can provide other placeholders through `custom_placeholders`, which must be
a list of dictionaries. The number of elements in the list must be the
same as the number of observations, and each dictionary will be used to
determine the placeholders for the file name related to the corresponding
observation. Here is an example::
custom_dicts = [
{ "myvalue": "A" },
{ "myvalue", "B" },
{ "myvalue": "B" },
]
write_list_of_observations(
obs=[obs1, obs2], # Write two observations
path=".",
file_name_mask="tod_{myvalue}.h5",
custom_dicts=custom_dicts,
custom_placeholders=custom_dicts,
)
# The two observations will be saved in
Expand Down

0 comments on commit c12b58f

Please sign in to comment.