Skip to content

Commit

Permalink
Tweaks to statistical function docstrings
Browse files Browse the repository at this point in the history
`N-correction` becomes `N - correction` to avoid confusing subtraction with hyphenation
  • Loading branch information
ndgrigorian committed Apr 4, 2024
1 parent b810771 commit 5ed388c
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions dpctl/tensor/_statistical_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ def var(x, axis=None, correction=0.0, keepdims=False):
Default: `None`.
correction (Optional[float, int]):
degrees of freedom adjustment. The divisor used in calculating the
variance is `N-correction`, where `N` corresponds to the total
variance is `N - correction`, where `N` corresponds to the total
number of elements over which the variance is calculated.
Default: `0.0`.
keepdims (Optional[bool]):
Expand Down Expand Up @@ -341,7 +341,7 @@ def std(x, axis=None, correction=0.0, keepdims=False):
over the entire array. Default: `None`.
correction (Optional[float, int]):
degrees of freedom adjustment. The divisor used in calculating the
standard deviation is `N-correction`, where `N` corresponds to the
standard deviation is `N - correction`, where `N` corresponds to the
total number of elements over which the standard deviation is
calculated. Default: `0.0`.
keepdims (Optional[bool]):
Expand Down

0 comments on commit 5ed388c

Please sign in to comment.