Skip to content

Commit 710bea3

Browse files
committed
STY: Moved Notes to after Return
1 parent b0d01fe commit 710bea3

1 file changed

Lines changed: 10 additions & 9 deletions

File tree

pysatMagVect/_core.py

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1560,10 +1560,6 @@ def apex_distance_after_local_step(glats, glons, alts, dates,
15601560
distance between magnetic field lines at the magnetic apex when starting
15611561
locally with a field line half distance of edge_length.
15621562
1563-
Note
1564-
----
1565-
vector direction refers to the magnetic unit vector direction
1566-
15671563
Parameters
15681564
----------
15691565
glats : list-like of floats (degrees)
@@ -1588,6 +1584,11 @@ def apex_distance_after_local_step(glats, glons, alts, dates,
15881584
np.array
15891585
The change in field line apex locations.
15901586
1587+
1588+
Note
1589+
----
1590+
vector direction refers to the magnetic unit vector direction
1591+
15911592
"""
15921593

15931594
# use spacecraft location to get ECEF
@@ -1767,11 +1768,6 @@ def heritage_scalars_for_mapping_ion_drifts(glats, glons, alts, dates, step_size
17671768
17681769
Use scalars_for_mapping_ion_drifts instead.
17691770
1770-
Note
1771-
----
1772-
Directions refer to the ion motion direction e.g. the zonal
1773-
scalar applies to zonal ion motions (meridional E field assuming ExB ion motion)
1774-
17751771
Parameters
17761772
----------
17771773
glats : list-like of floats (degrees)
@@ -1794,6 +1790,11 @@ def heritage_scalars_for_mapping_ion_drifts(glats, glons, alts, dates, step_size
17941790
for southern locations. 'equator_mer_drifts_scalar' and
17951791
'equator_zonal_drifts_scalar' cover the mappings to the equator.
17961792
1793+
Note
1794+
----
1795+
Directions refer to the ion motion direction e.g. the zonal
1796+
scalar applies to zonal ion motions (meridional E field assuming ExB ion motion)
1797+
17971798
"""
17981799

17991800
if step_size is None:

0 commit comments

Comments
 (0)