Commit 6c9c58a0 authored by Qusai Al Shidi's avatar Qusai Al Shidi
Browse files

Documentation fixes

parent dffef34f
......@@ -113,7 +113,7 @@ pip install -U --user drms
**Returns**:
(str) list of filenames downloaded.
- `str` - list of filenames downloaded.
**Raises**:
......@@ -221,12 +221,9 @@ text file into a dictionary of lists.
**Returns**:
- `dict` - {
Auroral indeces 'AL', 'AE', 'AO', 'AU' (int): {
'times' (datetime.datetime)
- `'values'` _int_ - List of indeces.
}
- `dict` - Auroral indeces 'AL', 'AE', 'AO', 'AU'
- `datetime.datetime` - 'times'
- `int` - 'values'
<a name=".swmfpy.io.read_wdc_asy_sym"></a>
#### read\_wdc\_asy\_sym
......@@ -248,8 +245,7 @@ and puts it into a dictionary.
**Returns**:
- `dict` - of values.
- `{'[ASY-SYM]-[D-H]'` - 'times': [], 'values': []}
- `dict` - of values. {'[ASY-SYM]-[D-H]': 'times': [], 'values': []}
**Examples**:
......@@ -290,7 +286,7 @@ from the GM model log.
**Returns**:
Dictionary of the log file
- `dict` - Dictionary of the log file
**Examples**:
......
......@@ -17,12 +17,9 @@ def read_wdc_ae(wdc_filename):
wdc_filename (str): Filename of wdc data from
http://wdc.kugi.kyoto-u.ac.jp/
Returns:
dict: {
Auroral indeces 'AL', 'AE', 'AO', 'AU' (int): {
'times' (datetime.datetime)
'values' (int): List of indeces.
}
dict: Auroral indeces 'AL', 'AE', 'AO', 'AU'
datetime.datetime: 'times'
int: 'values'
"""
# Initialize return data
......@@ -71,8 +68,7 @@ def read_wdc_asy_sym(wdc_filename):
wdc_filename (str): Relative filename (or file handle no.) to read.
Returns:
dict: of values.
{'[ASY-SYM]-[D-H]': 'times': [], 'values': []}
dict: of values. {'[ASY-SYM]-[D-H]': 'times': [], 'values': []}
Examples:
```python
......@@ -169,7 +165,7 @@ def read_gm_log(filename, colnames=None, dtypes=None, index_time=True):
in dictionary key 'Time [UT]'.
Returns:
Dictionary of the log file
dict: Dictionary of the log file
Examples:
To plot AL and Dst get the log files
......
......@@ -163,7 +163,7 @@ def download_magnetogram_hmi(mag_time, **kwargs):
verbose (bool): (default False) print out the files it's downloading.
Returns:
(str) list of filenames downloaded.
str: list of filenames downloaded.
Raises:
ImportError: If module `drms` is not found.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment