doc improvements #22289
doc improvements #22289
Conversation
KristofferC
added
backport pending 0.6
domain:docs
|
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.
=Int doesn't make much sense here
There was a problem hiding this comment.
There was a problem hiding this comment.
What should it be? ::Int?
There was a problem hiding this comment.
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.
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.
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