Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

DOC: documenting identical information across classes, methods and attributes #525

Open
josef-pkt opened this Issue · 0 comments

1 participant

@josef-pkt
Owner

a full class docstring with good overview information

http://statsmodels.sourceforge.net/devel/generated/statsmodels.regression.linear_model.RegressionResults.html#statsmodels.regression.linear_model.RegressionResults

class docstring that just points out the difference:

http://statsmodels.sourceforge.net/devel/generated/statsmodels.regression.linear_model.OLSResults.html#statsmodels.regression.linear_model.OLSResults

I think this is a good split overall

things to improve:

1) given that we don't have problems with docstrings in cached attributes anymore, we should add those.
I would prefer to have an indication that they use attribute access, without the misleading (). This should be indicated in the 1st line of the description (CA cached attribute or similar)

2) more explanatory information:
I was looking at this again during the recent rsquared definition discussion
Stata has a good FAQ pages about missing rsquared and how to calculate it and how (not) to interpret it, for example
http://www.stata.com/support/faqs/statistics/r-squared/
http://www.stata.com/support/faqs/statistics/two-stage-least-squares/
As we clarify issues like these it would be useful to have a more extensive documentation, but not necessarily in the individual doc strings, for example just a link to another page for details (technical details that we have never written).

My target would be to have a more central location for a more extensive documentation of parts that are common to many models and results classes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.