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

Move documentation inline for error types declared in base/base.jl. #17959

Merged
merged 1 commit into from
Aug 12, 2016

Conversation

xorJane
Copy link
Contributor

@xorJane xorJane commented Aug 11, 2016

I've moved the documentation inline for types SystemError, ParseError, ArgumentError, KeyError, MethodError, EOFError, DimensionMismatch, AssertionError, LoadError, and InitError. Hope that helps!

@@ -4,15 +4,32 @@ type SystemError <: Exception
prefix::AbstractString
errnum::Int32
extrainfo
@doc """
SystemError(prefix::AbstractString, [errno::Int32])
Copy link
Member

Choose a reason for hiding this comment

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

3-space indent here, should be 4 to be recognised as a code block.

@MichaelHatherly
Copy link
Member

Hope that helps!

💯

@KristofferC
Copy link
Member

Base.jl is getting thinner and thinner :)

@MichaelHatherly
Copy link
Member

Only 7869 lines to go!

@tkelman tkelman added docs This change adds or pertains to documentation backport pending 0.5 labels Aug 11, 2016
@xorJane
Copy link
Contributor Author

xorJane commented Aug 11, 2016

Great, I made the modifications suggested. Thank you for the feedback @MichaelHatherly!

@kshyatt
Copy link
Contributor

kshyatt commented Aug 11, 2016

This was on my to-do list and you beat me! Nice work! 💯

AssertionError(msg) = new(msg)
AssertionError() = new("")
Copy link
Member

Choose a reason for hiding this comment

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

Changing the definition order probably won't affect anything, but best to avoid unrelated changes if possible. Other than that the PR looks go to me, thanks.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Reordered!

@kshyatt
Copy link
Contributor

kshyatt commented Aug 11, 2016

Also, @xorJane, this is your second Julia PR, right? (Belated) Welcome to Julia if so!

@xorJane
Copy link
Contributor Author

xorJane commented Aug 11, 2016

Thanks @kshyatt !

@tkelman tkelman merged commit 87e00a1 into JuliaLang:master Aug 12, 2016
tkelman pushed a commit that referenced this pull request Aug 20, 2016
@waldyrious waldyrious mentioned this pull request Sep 7, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants