Skip to content

Commit caf342d

Browse files
committed
DOC: Fix docstrings
Fix broken docstrings Add changes Prepare for release 4.11
1 parent 217ee8e commit caf342d

File tree

3 files changed

+9
-4
lines changed

3 files changed

+9
-4
lines changed

arch/univariate/base.py

+4
Original file line numberDiff line numberDiff line change
@@ -1414,6 +1414,8 @@ def scale(self):
14141414

14151415
def conf_int(self, alpha=0.05):
14161416
"""
1417+
Parameter confidence intervals
1418+
14171419
Parameters
14181420
----------
14191421
alpha : float, optional
@@ -1575,10 +1577,12 @@ def rsquared(self):
15751577

15761578
@cached_property
15771579
def fit_start(self):
1580+
"""Start of sample used to estimate parameters"""
15781581
return self._fit_indices[0]
15791582

15801583
@cached_property
15811584
def fit_stop(self):
1585+
"""End of sample used to estimate parameters"""
15821586
return self._fit_indices[1]
15831587

15841588
@cached_property

arch/univariate/distribution.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -417,11 +417,11 @@ def ppf(self, pits, parameters=None):
417417

418418
class SkewStudent(Distribution):
419419
r"""
420-
Standardized Skewed Student's [1]_ distribution for use with ARCH models
420+
Standardized Skewed Student's distribution for use with ARCH models
421421
422422
Notes
423423
-----
424-
The Standardized Skewed Student's distribution takes two parameters,
424+
The Standardized Skewed Student's distribution ([1]_) takes two parameters,
425425
:math:`\eta` and :math:`\lambda`. :math:`\eta` controls the tail shape
426426
and is similar to the shape parameter in a Standardized Student's t.
427427
:math:`\lambda` controls the skewness. When :math:`\lambda=0` the

doc/source/changes/4.0.txt

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
Version 4
33
=========
44

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

0 commit comments

Comments
 (0)