-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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 improvements #22289
doc improvements #22289
Conversation
more specific commit message |
base/parse.jl
Outdated
0.0012 | ||
``` | ||
""" | ||
function parse(T::Type, str, base=Int) end |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
=Int
doesn't make much sense here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks wrong there too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What should it be? ::Int
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like it was a manual mistake in 9e6aecc that no one noticed
In the 3-arg method with a base it's constrained to be ::Integer
. In the 2-arg method below 0 gets passed instead of check_valid_base(base)
, but a comment says # Zero means, "figure it out"
which isn't consistent with "the default is 10" from the docstring. parse(Int, "0b01", 10)
errors and parse(Int, "0b01")
doesn't...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also I believe the syntax here is wrong. This defines a function.
Please suggest a more specific commit message. Could be fixed on squash. |
"added doctests for ..., moved docstrings for ... inline" |
base/parse.jl
Outdated
0.0012 | ||
``` | ||
""" | ||
function parse(T::Type, str, base=Int) end |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also I believe the syntax here is wrong. This defines a function.
Will rebase after #22515 |
This is smaller and ready, please do the other way around. Let people review things by leaving them open at least a day or so if there's no urgent rush. |
What is this referring to? |
Anyway, this is ready to go as far as I am concerned. |
|
There wouldn't be any point rebasing it before #22515? |
some random doctests, moving things from Base.jl
plz no goalpost moving