DOC: Documentation fixes #1980

Merged
merged 21 commits into from Sep 21, 2014

Projects

None yet

3 participants

@jseabold
Member

Clean up documentation. Fix many problems that have crept in in new code. Closes all outstanding documentation issues for 0.6.

closes :`
#1532
#1386
#1069
#546
#1337

@coveralls

Coverage Status

Coverage increased (+0.01%) when pulling b9c993a on jseabold:docs-fixes into 0529da7 on statsmodels:master.

@josef-pkt josef-pkt commented on the diff Sep 21, 2014
docs/source/duration.rst
References
^^^^^^^^^^
References for Cox proportional hazards regression model::
-T Therneau (1996). Extending the Cox model. Technical report.
-http://www.mayo.edu/research/documents/biostat-58pdf/DOC-10027288
+ T Therneau (1996). Extending the Cox model. Technical report.
+ http://www.mayo.edu/research/documents/biostat-58pdf/DOC-10027288
@josef-pkt
josef-pkt Sep 21, 2014 Member

why are they intended ?
I did the same without intendation for gee.rst

@jseabold
jseabold Sep 21, 2014 Member

The :: signals a literal block that needs indentation.

@josef-pkt josef-pkt commented on the diff Sep 21, 2014
statsmodels/regression/linear_model.py
@@ -240,9 +238,9 @@ def fit_regularized(self, method="coord_descent", maxiter=1000,
Must be between 0 and 1 (inclusive). If 0, the fit is
ridge regression. If 1, the fit is the lasso.
start_params : array-like
- Starting values for `params`.
+ Starting values for ``params``.
@josef-pkt
josef-pkt Sep 21, 2014 Member

why double back-ticks ?
I thought code is single.
(I paid little attention to this on the scipy issue discussion)

@jseabold
jseabold Sep 21, 2014 Member

Inline literal is double backticks. Single backticks is undefined. It doesn't really matter I just think the inline literal looks better.

@jseabold jseabold DOC: Fix typo.
dd40547
@josef-pkt
Member

looks good, (I'm not a fan of kwargs and prefer fit_kwds

I did the gee.rst file in the same style as mixed and duration, but I saw several changes in here.
Are those needed? Then I need to update my rst pattern or knowledge.

@jseabold
Member

I didn't change the kwargs, it was already there. I just removed the redundant dict(kwargs) call and internal renaming. It doesn't matter to me what it's called.

@jseabold
Member

There was nothing structurally wrong with files. I just removed some of the TODO to a todo directive in those files and fixed a block literal. The example stuff still doesn't exist, so that should probably be commented out too. It's just creating warning noise in the bulid. The more serious stuff was the loose headers in a lot of the new code and the underlines. These names have to be exact for numpyext.

@coveralls

Coverage Status

Coverage increased (+0.01%) when pulling dd40547 on jseabold:docs-fixes into 0529da7 on statsmodels:master.

@jseabold jseabold merged commit 7134eb0 into statsmodels:master Sep 21, 2014

2 checks passed

continuous-integration/appveyor AppVeyor build succeeded
Details
continuous-integration/travis-ci The Travis CI build passed
Details
@jseabold jseabold deleted the jseabold:docs-fixes branch Sep 21, 2014
@josef-pkt
Member

edited description to get cross-links between issues and PR

@josef-pkt josef-pkt added the comp-docs label Sep 21, 2014
@josef-pkt josef-pkt added this to the 0.6 milestone Sep 21, 2014
@josef-pkt
Member

and PRs like issues need labels and milestone (if relevant)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment