Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from Sep 26, 2014

Conversation

Projects
None yet
3 participants
@jseabold
Copy link
Member

commented Sep 26, 2014

No description provided.

@coveralls

This comment has been minimized.

Copy link

commented Sep 26, 2014

Coverage Status

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

@@ -19,15 +19,14 @@ Examples
The following illustrates a Poisson regression with exchangeable correlation
within clusters using data on epilepsy seizures.

::
.. ipython:: python

This comment has been minimized.

Copy link
@josef-pkt

josef-pkt Sep 26, 2014

Member

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

This comment has been minimized.

Copy link
@jseabold

jseabold Sep 26, 2014

Author Member

The code is run and the summary is displayed.

This comment has been minimized.

Copy link
@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

This comment has been minimized.

Copy link
@jseabold

jseabold Sep 26, 2014

Author 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 force-pushed the jseabold:cov-struct-docs branch from 5375e39 to 69989bc Sep 26, 2014

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

@jseabold

This comment has been minimized.

Copy link
Member Author

commented Sep 26, 2014

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

jseabold added a commit that referenced this pull request Sep 26, 2014

Merge pull request #2009 from jseabold/cov-struct-docs
DOC: Update after refactor. Use code block.

@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

This comment has been minimized.

Copy link
Member

commented Sep 26, 2014

:: 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
You can’t perform that action at this time.