Skip to content

Commit

Permalink
DOC: Fix docstrings
Browse files Browse the repository at this point in the history
Fix broken docstrings
Add changes
Prepare for release 4.11
  • Loading branch information
bashtage committed Nov 22, 2019
1 parent 217ee8e commit caf342d
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
4 changes: 4 additions & 0 deletions arch/univariate/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -1414,6 +1414,8 @@ def scale(self):

def conf_int(self, alpha=0.05):
"""
Parameter confidence intervals
Parameters
----------
alpha : float, optional
Expand Down Expand Up @@ -1575,10 +1577,12 @@ def rsquared(self):

@cached_property
def fit_start(self):
"""Start of sample used to estimate parameters"""
return self._fit_indices[0]

@cached_property
def fit_stop(self):
"""End of sample used to estimate parameters"""
return self._fit_indices[1]

@cached_property
Expand Down
4 changes: 2 additions & 2 deletions arch/univariate/distribution.py
Original file line number Diff line number Diff line change
Expand Up @@ -417,11 +417,11 @@ def ppf(self, pits, parameters=None):

class SkewStudent(Distribution):
r"""
Standardized Skewed Student's [1]_ distribution for use with ARCH models
Standardized Skewed Student's distribution for use with ARCH models
Notes
-----
The Standardized Skewed Student's distribution takes two parameters,
The Standardized Skewed Student's distribution ([1]_) takes two parameters,
:math:`\eta` and :math:`\lambda`. :math:`\eta` controls the tail shape
and is similar to the shape parameter in a Standardized Student's t.
:math:`\lambda` controls the skewness. When :math:`\lambda=0` the
Expand Down
5 changes: 3 additions & 2 deletions doc/source/changes/4.0.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
Version 4
=========

Since 4.10
==========
Release 4.11
============
- Added :func:`~arch.univariate.base.ARCHModelResult.std_resid` (:issue:`326`).
- Error if inputs are not ndarrays, DataFrames or Series (:issue:`315`).
- Added a check that the covariance is non-zero when using "studentized" confidence intervals.
If the function bootstrapped produces statistics with 0 variance, it is not possible to
Expand Down

0 comments on commit caf342d

Please sign in to comment.