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

Added 'getting started' to documentation #350

Merged
merged 3 commits into from
Mar 9, 2015
Merged

Added 'getting started' to documentation #350

merged 3 commits into from
Mar 9, 2015

Conversation

cgoldammer
Copy link
Contributor

I followed the style in the DataFrames documentation. Thus, it's intended as a walk-through of the basic features without links to the more detailed documentation. For code blocks, the display differs from the rest of the documentation because I include the ">julia" from the REPL. This is because I want to include both code and output.

Very much looking forward to feedback. Happy to add more or do extensive editing as needed.


.. code-block:: julia

julia> normal = Normal()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think using case only to distinguish an object from a type is a little confusing for a beginner.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would be easier? Omitting line 22 and just saying x=rand(Normal(), 100)? Or would you want me to use different notation?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I often use d for a distribution object.

@johnmyleswhite
Copy link
Member

This is great. Thanks so much for working on this.

@cgoldammer
Copy link
Contributor Author

@johnmyleswhite, thanks for the comments, that all makes sense.

I edited based on your comments and did some general editing on top of it.

Also, I removed the Truncated type from the list of "main types", because that's likely confusing. Instead, I introduce the Truncated type through its own line. The main types are Univariate, Multivariate, and Matrixvariate.

@cgoldammer
Copy link
Contributor Author

A quick note: Upon submitting my initial pull commit, the checks initially failed. Travis said that code coverage decreased by 10%. Within 1/2 hour or so, this got updated to the correct change (0%). For this commit, Travis fails to build (on the nightly build of Julia).

Not sure what's causing this issue. Happy to forward this issue to the right location if you know where that is.

@simonster
Copy link
Member

This might be because we run code coverage on both Julia release and nightly and they give different results for reasons unrelated to the package.

@cgoldammer
Copy link
Contributor Author

@simonster Good to know!. Apologies for closing and re-opening, just a bad click.

@cgoldammer cgoldammer closed this Mar 8, 2015
@cgoldammer cgoldammer reopened this Mar 8, 2015
simonbyrne added a commit that referenced this pull request Mar 9, 2015
Added 'getting started' to documentation
@simonbyrne simonbyrne merged commit 8355bc6 into JuliaStats:master Mar 9, 2015
@simonbyrne
Copy link
Member

Fantastic, thanks for doing this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants