Skip to content

Commit

Permalink
Slight docstring reformatting for readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
jameswilburlewis committed Apr 22, 2024
1 parent c085f00 commit 563ea92
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
13 changes: 10 additions & 3 deletions pytplot/tplot_math/deflag.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ def deflag(tvar, flag=None, newname=None, new_tvar=None, method=None, fillval=No
Replaces FLAGs in arrays with interpolated or other values.
Optionally removes NaN values from a variable
Parameters:
Parameters
----------
tvar: str
Name of tplot variable to use for data clipping.
flag : int,list
Expand All @@ -36,10 +38,15 @@ def deflag(tvar, flag=None, newname=None, new_tvar=None, method=None, fillval=No
multiple or pseudo variables, the data is overwritten.
fillval: int, float (optional)
Value to use as replacement when method='replace'
Restrictions:
Notes
-----
deflag only works for 1 or 2-d data arrays; ntimes or (ntimes, nspectral_bins)
Returns:
Returns
-------
None
Examples
Expand Down
6 changes: 3 additions & 3 deletions pytplot/tplot_math/tdotp.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

def tdotp(variable1, variable2, newname=None):
"""
Routine to calculate the dot product of two tplot variables
containing arrays of vectors and storing the results in a
tplot variable
Routine to calculate the dot product of two tplot variables
containing arrays of vectors and storing the results in a
tplot variable
Parameters
-----------
Expand Down

0 comments on commit 563ea92

Please sign in to comment.