Skip to content

Commit

Permalink
[DOC] fix loc/scale parameter names in TDistribution docstring (#61)
Browse files Browse the repository at this point in the history
Fixes location-scale parameter names in the docstring of
`TDistribution`, the parameter names in the docstring were inconsistent
with the actual parameter names.

FYI @Alex-JG3, before we release we can easily switch that either way -
do you have a preference?
My default action is always to fix the docstring if the logic and the
docstring disagree.
  • Loading branch information
fkiraly authored Sep 9, 2023
1 parent 26fb332 commit 62f19bd
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions skpro/distributions/t.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ class TDistribution(BaseDistribution):
Parameters
----------
mean : float or array of float (1D or 2D)
mu : float or array of float (1D or 2D)
mean of the t-distribution distribution
sd : float or array of float (1D or 2D), must be positive
sigma : float or array of float (1D or 2D), must be positive
standard deviation of the t-distribution distribution
df : float or array of float (1D or 2D), must be positive
Degrees of freedom of the t-distribution
Expand Down

0 comments on commit 62f19bd

Please sign in to comment.