Merge pull request #6943 from bashtage/document-warnings-exceptions

DOC: Document exceptions and warnings

docs/source/dev/index.rst

@@ -99,6 +99,7 @@ Contents
    maintainer_notes
    test_notes
    naming_conventions
+   warnings-and-exceptions
    dataset_notes
    examples
    get_involved

docs/source/dev/warnings-and-exceptions.rst

@@ -0,0 +1,58 @@
+=======================
+Exceptions and Warnings
+=======================
+
+Exceptions
+----------
+
+Errors derive from Exception or another custom error. Custom errors are
+only needed if standard errors, for example ValueError or TypeError, are not
+accurate descriptions of the cause for the error.
+
+.. module:: statsmodels.tools.sm_exceptions
+   :synopsis: Exceptions and Warnings
+
+.. currentmodule:: statsmodels.tools.sm_exceptions
+
+.. autosummary::
+   :toctree: generated/
+
+   ParseError
+   PerfectSeparationError
+   X13NotFoundError
+   X13Error
+
+Warnings
+--------
+
+Warnings derive from either an existing warning or another custom
+warning, and are often accompanied by a string using the format
+``warning_name_doc`` that services as a generic message to use when the
+warning is raised.
+
+
+.. currentmodule:: statsmodels.tools.sm_exceptions
+
+.. autosummary::
+   :toctree: generated/
+
+   X13Warning
+   IOWarning
+   ModuleUnavailableWarning
+   ModelWarning
+   ConvergenceWarning
+   CacheWriteWarning
+   IterationLimitWarning
+   InvalidTestWarning
+   NotImplementedWarning
+   OutputWarning
+   DomainWarning
+   ValueWarning
+   EstimationWarning
+   SingularMatrixWarning
+   HypothesisTestWarning
+   InterpolationWarning
+   PrecisionWarning
+   SpecificationWarning
+   HessianInversionWarning
+   CollinearityWarning

docs/source/names_wordlist.txt

@@ -14,6 +14,7 @@ Azzalini
 Bai
 Bakirov
 Balazs
+Baran
 Bańbura
 Behrens
 Benjamini
@@ -23,6 +24,7 @@ Billah
 Biometrical
 Biopharmaceutical
 Biostatistics
+Blunck
 Borenstein
 Breslow
 Breusch
@@ -31,9 +33,13 @@ Bronwyn
 Broyden
 Chantal
 Charlier
+Chaudhuri
 Chichester
+Cinthia
 Clauss
 Commandeur
+Conaway
+Coster
 Cribbie
 Degreeds
 Denton
@@ -58,6 +64,7 @@ Finney
 Fioruci
 Fleiss
 Forsythe
+Galuzio
 Gangat
 Gelman
 Geng
@@ -78,13 +85,15 @@ Hamdi
 Hampel
 Hannan
 Hanszel
+Haoyu
 Hartung
 Hassan
 Hastie
 Hauck
 Hausman
 Helmert
 Helmut
+Henning
 Herbst
 Hertzprung
 Hobson
@@ -107,6 +116,7 @@ Josef
 Jurgen
 Kacker
 Kaplan
+Karakus
 Kerby
 Kibirige
 Knotek
@@ -116,8 +126,10 @@ Kolmogorov
 Koopman
 Kotz
 Kraay
+Kumar
 Kwiatkowski
 Lakhotia
+Larralde
 Levene
 Levinson
 Liang
@@ -128,10 +140,14 @@ Lobato
 Longley
 Louzada
 Lucrezia
+Lyttle
+Löning
 Lütkepohl
 MacKinnon
 Mahalanobis
 Mandel
+Manmeet
+Markus
 Mazon
 Mehrotra
 Merothra
@@ -151,13 +167,16 @@ Oneway
 Ord
 Ozen
 Paule
+Paulo
 Pellegrini
 Pelletier
 Penrose
 Perktold
 Petropoulos
 Piet
 Ploberger
+Pölsterl
+Qi
 Qingqing
 Quackenbush
 Raphson
@@ -172,6 +191,7 @@ Saggiorato
 Samesh
 Sandu
 Satterthwait
+Scherrer
 Scholl
 Schucany
 Schwarz
@@ -196,6 +216,7 @@ Stata
 Steiger
 Surico
 Szekely
+Tanaka
 Theano
 Tibshirani
 Tukey
@@ -208,6 +229,7 @@ Wellek
 Wes
 Wichern
 Wishart
+Wouter
 Yao
 Yasine
 Yichuan
@@ -223,4 +245,11 @@ hannan
 luxiform
 oaxaca
 partev
-seabold
+seabold
+zveryansky
+Řehůřek
+郭飞
+Ananyev
+Zhiqing
+adrienpacifico
+aeturrell