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.

Sign up for GitHub

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

Jump to bottom

DOC: stats: Split the descriptions of the distributions in the tutorial into separate files. #4008

Merged
merged 4 commits into from Sep 23, 2014
Merged

DOC: stats: Split the descriptions of the distributions in the tutorial into separate files. #4008

merged 4 commits into from Sep 23, 2014

Conversation

WarrenWeckesser
Copy link
Member

Closes gh-3935.

@WarrenWeckesser
DOC: stats: Maintenance work on the distribution docs in the stats tu…
178749a 
…torial.

* Added links to implementations in the list of distributions in the tutorial.
* Removed distributions from the .rst files that are not implemented in scipy:
    continuous.rst:
        Doubly Non-central F
        Doubly Non-central t
        Noncentral beta
        Noncentral chi
        Studentized Range
        Symmetric Power
        Wishart
        Student Z
    discrete.rst
        Discete Gaussian
* Fixed spelling of "Saunders" in "Birnbaum-Saunders".
* Removed extraneous blank lines.
@WarrenWeckesser
DOC: stats: Maintenance work on the distribution docs in the stats tu…
6cc1a49 
…torial.

Created a separate .rst file for each distribution.
@WarrenWeckesser
DOC: stats: Fix whitespace in the LaTeX formulas of some distributions.
15c2479
@WarrenWeckesser
DOC: stats: Remove extraneous LaTeX brackets from discrete.rst.
018e69e
@WarrenWeckesser WarrenWeckesser mentioned this pull request Sep 20, 2014
Closed
@WarrenWeckesser
Copy link
Member Author

@ev-br: If you have a chance, could you take a look at this PR? @rgommers suggested the split in #3935, as a follow-up to #3911.

@WarrenWeckesser WarrenWeckesser added Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.stats maintenance Items related to regular maintenance tasks labels Sep 20, 2014
@WarrenWeckesser WarrenWeckesser added this to the 0.15.0 milestone Sep 20, 2014
@coveralls
Copy link

Coverage Status

Coverage remained the same when pulling 018e69e on WarrenWeckesser:doc-split-distr into c532eb8 on scipy:master.

@ev-br
Copy link
Member

ev-br commented Sep 23, 2014

Looks great, thanks!
I'm not up to checking all the formulas :-), but this is now doable, at least in principle. The main problem with these files now is that they are too well hidden from view. Even though I know they exist, finding them is what, five clicks?

Strictly speaking, this material looks to belong to reference material rather than tutorial, but OK, practicality beats purity and all that.
It'd be useful though to eg add backlinks from individual distributions to these pages, but I've no idea how to do it.

Meanwhile, further enhancement can be done separately, am merging this PR.

ev-br added a commit that referenced this pull request Sep 23, 2014
@ev-br
Merge pull request #4008 from WarrenWeckesser/doc-split-distr
790d7e9 
DOC: stats: Split the descriptions of the distributions in the tutorial into separate files.
@ev-br ev-br merged commit 790d7e9 into scipy:master Sep 23, 2014
@WarrenWeckesser WarrenWeckesser deleted the doc-split-distr branch September 23, 2014 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org maintenance Items related to regular maintenance tasks scipy.stats
Projects
None yet
Milestone
0.15.0
Development

Successfully merging this pull request may close these issues.

Split stats.distributions files in tutorial
3 participants
@WarrenWeckesser @coveralls @ev-br