DOC: Update after refactor. Use code block. #2009

Merged
merged 1 commit into from Sep 26, 2014

Projects

None yet

3 participants

@jseabold
Member

No description provided.

@coveralls

Coverage Status

Coverage remained the same when pulling 5375e39 on jseabold:cov-struct-docs into a4e4eb8 on statsmodels:master.

@josef-pkt josef-pkt and 1 other commented on an outdated diff Sep 26, 2014
docs/source/gee.rst
@@ -19,15 +19,14 @@ Examples
The following illustrates a Poisson regression with exchangeable correlation
within clusters using data on epilepsy seizures.
-::
+.. ipython:: python
@josef-pkt
josef-pkt Sep 26, 2014 Member

what's the difference between using ipython directive and plain ::?

@jseabold
jseabold Sep 26, 2014 Member

The code is run and the summary is displayed.

@josef-pkt
josef-pkt Sep 26, 2014 Member

I don't think we did this in any of the main rst files. It's just supposed to be an illustration, with reference to real examples. http://statsmodels.sourceforge.net/devel/regression.html and others

should we change this?
I don't know how it looks like, but it might be distracting at the top level

@jseabold
jseabold Sep 26, 2014 Member

I don't really care. I just figured if we're printing the summary, we should show it. I'll take it out but it should still at least be a code-block instead of a literal block.

@jseabold jseabold changed the title from DOC: Update after refactor. Use ipython directive. to DOC: Update after refactor. Use code block. Sep 26, 2014
@jseabold
Member

I have a release notes branch with the fix for that one.

@jseabold jseabold merged commit 7f42939 into statsmodels:master Sep 26, 2014

1 check was pending

continuous-integration/travis-ci The Travis CI build is in progress
Details
@jseabold jseabold deleted the jseabold:cov-struct-docs branch Sep 26, 2014
@josef-pkt
Member

:: is a code block with python syntax highlighting
http://statsmodels.sourceforge.net/devel/regression.html

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