Skip to content

Commit

Permalink
Tweak formatting of sem docstring for readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
jameswilburlewis committed Apr 26, 2024
1 parent 5819656 commit d5568d6
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions pyspedas/poes/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,15 @@ def sem(trange=['2018-11-5', '2018-11-6'],
Parameters
----------
trange : list of str, default=['2018-11-5', '2018-11-6']
trange : list of str
time range of interest [starttime, endtime] with the format
['YYYY-MM-DD','YYYY-MM-DD'] or to specify more or less than a day
['YYYY-MM-DD/hh:mm:ss','YYYY-MM-DD/hh:mm:ss']
Default: ['2018-11-5', '2018-11-6']
probe: str or list of str, default=['noaa19']
probe: str or list of str
POES spacecraft name(s); e.g., metop1, metop2, noaa15, noaa16,
noaa18, noaa19
noaa18, noaa19. Default: noaa19
datatype: str, optional
This variable is unused. It is reserved for the future use.
Expand All @@ -35,30 +36,29 @@ def sem(trange=['2018-11-5', '2018-11-6'],
no suffix is added.
get_support_data: bool, default=False
Data with an attribute "VAR_TYPE" with a value of "support_data"
will be loaded into tplot. By default, only loads in data with a
"VAR_TYPE" attribute of "data".
If True, data with an attribute "VAR_TYPE" with a value of "support_data"
will be loaded into tplot. Default: False
varformat: str, default=False
The file variable formats to load into tplot. Wildcard character
`*` is accepted. By default, all variables are loaded in.
varformat: str
If specified, file variable formats to load into tplot. Wildcard characters
`*` and `?` are accepted. By default, all variables are loaded in.
varnames: list of str, optional
List of variable names to load (if not specified,
all data variables are loaded)
downloadonly: bool, default=False
downloadonly: bool
Set this flag to download the CDF files, but not load them into
tplot variables
tplot variables. Default: False
notplot: bool, default=False
Return the data in hash tables instead of creating tplot variables
notplot: bool
Return the data in hash tables instead of creating tplot variables. Default: False
no_update: bool, default=False
If set, only load data from your local cache
no_update: bool
If set, only load data from your local cache. Default: False
time_clip: bool, default=False
Time clip the variables to exactly the range specified in the trange keyword
time_clip: bool
Time clip the variables to exactly the range specified in the trange keyword. Default: False
Returns
-------
Expand Down

0 comments on commit d5568d6

Please sign in to comment.