Move docs inline from helpdb and add a couple doctests #22651
Conversation
| full(F) | ||
|
|
||
| Reconstruct the matrix `A` from the factorization `F=factorize(A)`. | ||
| """ |
There was a problem hiding this comment.
(Tangent: This docstring for full only captures one of the various meanings of full. Perhaps we should flesh out this docstring? Or not worry about it in anticipation of complete excision of full in this release cycle?)
There was a problem hiding this comment.
If it were me I'd just leave it as-is, since that's a larger task than simply relocating the docstring.
base/strings/types.jl
Outdated
| "ailuJ" | ||
|
|
||
| julia> for i in 1:length(r) | ||
| print(r[reverseind(s, i)]) |
base/floatfuncs.jl
Outdated
| Rounds (in the sense of [`round`](@ref)) `x` so that there are `digits` significant digits, under a | ||
| base `base` representation, default 10. | ||
|
|
||
| ```jldoctest |
base/strings/types.jl
Outdated
| `v[reverseind(v,i)] == reverse(v)[i]`. (This can be nontrivial in the case where `v` is a | ||
| Unicode string.) | ||
|
|
||
| ```jldoctest |
There was a problem hiding this comment.
I added # Examples to a few other places in the files I touched.
| exit([code]) | ||
|
|
||
| Quit (or control-D at the prompt). The default exit code is zero, indicating that the | ||
| processes completed successfully. |
There was a problem hiding this comment.
does processes being plural here sound redundant / a little off to anyone else?
There was a problem hiding this comment.
Sounded a little off on first read, yes. Technically more correct than a singular equivalent though I suppose.
On that note, the "control-D at the prompt" snippet strikes me as out of place as well. Perhaps could be listed as a synonym instead? Also could use a ref to the quit() docstring.
There was a problem hiding this comment.
we should maybe note these as future todo cleanups somewhere
There was a problem hiding this comment.
Captured in an intro issue: #22765. Best!
|
(Absent objections, requests for time, or someone beating me to it, I plan to merge this tomorrow morning. Best!) |
I moved some docstrings inline, added a doctest for
reverseind, and converted the examples listed in the docstring forsignifto doctests.Thank you and happy weekend!
Ref #22521