Skip to content

Commit 7a87310

Browse files
updating the docstring
1 parent f378cd9 commit 7a87310

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

xga/generate/esass/spec.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -94,11 +94,10 @@ def _spec_cmds(sources: Union[BaseSource, BaseSample], outer_radius: Union[str,
9494
:param bool force_gen: This boolean flag will force the regeneration of spectra, even if they already exist.
9595
:param Union[CircleSkyRegion, EllipseSkyRegion, dict, List] custom_bkg: A region to extract the
9696
background spectrum from. If extracting a spectrum for a single source, and require unique
97-
background regions for each obs_id and instrument, this argument can be input as a nested
98-
dictionary with top level obs_id keys, and instrument keys on the next level
99-
({obs_id: {inst: reg}}). If extracting spectra from a sample, and require unique regions for
100-
each source, a list of dictionaries should be input, with an entry for each source. By
101-
default the background will be extracted from an annulus around the source.
97+
background regions for each obs_id, this argument can be input as a dictionary with obs_id
98+
keys, ie {'obs_id': reg}. If extracting spectra from a sample, and require unique regions for
99+
each source, a list of dictionaries, or regs should be input, with an entry for each source.
100+
By default the background will be extracted from an annulus around the source.
102101
"""
103102
def _append_spec_info(evt_list, s_ind):
104103
"""

0 commit comments

Comments
 (0)