Update docstring examples and code #970
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fence/indent/dedent code samples in docstrings with proper language tags so that built-in julia help and Documenter.jl can pick them up.
ablaom
reviewed
Apr 23, 2024
ablaom
reviewed
Apr 23, 2024
| X = source(1:10) | ||
| Y = @node selectrows(X, 3:4) | ||
| julia> X = source(1:10) | ||
| julia> Y = @node selectrows(X, 3:4) | ||
| julia> Y() |
ablaom
reviewed
Apr 23, 2024
ablaom
reviewed
Apr 23, 2024
ablaom
reviewed
Apr 23, 2024
ablaom
reviewed
Apr 23, 2024
ablaom
reviewed
Apr 23, 2024
| julia> @load LogisticClassifier pkg=MLJLinearModels | ||
| julia> X, y = @load_crabs; | ||
| julia> pipe = Standardizer() |> LogisticClassifier(); | ||
| julia> mach = machine(pipe, X, y) |> fit!; | ||
|
|
There was a problem hiding this comment.
I'd prefer to revert these. See previous comments on including julia> prompt.
ablaom
reviewed
Apr 23, 2024
ablaom
reviewed
Apr 23, 2024
ablaom
reviewed
Apr 23, 2024
src/show.jl
Outdated
|
|
||
| """ | ||
| function _recursive_show end |
ablaom
reviewed
Apr 23, 2024
ablaom
reviewed
Apr 23, 2024
| 2 | ||
|
|
||
| ```julia-repl | ||
| julia> object = (X = (x = 1, y = 2), Y = 3); |
There was a problem hiding this comment.
Suggested change
| julia> object = (X = (x = 1, y = 2), Y = 3); | |
| object = (X = (x = 1, y = 2), Y = 3); |
ablaom
reviewed
Apr 23, 2024
| @@ -293,7 +298,7 @@ column cycle fastest, those in the last clolumn slowest. | |||
|
|
|||
| ### Example | |||
|
|
|||
| ```julia | |||
| ```julia-repl | |||
| julia> iterators = ([1, 2], ["a","b"], ["x", "y", "z"]); | |||
There was a problem hiding this comment.
Suggested change
| julia> iterators = ([1, 2], ["a","b"], ["x", "y", "z"]); | |
| iterators = ([1, 2], ["a","b"], ["x", "y", "z"]); |
ablaom
reviewed
Apr 23, 2024
| ``` | ||
| existing_names = [] | ||
| ```julia-repl | ||
| julia> existing_names = []; |
There was a problem hiding this comment.
Suggested change
| julia> existing_names = []; | |
| existing_names = []; |
|
I'll investigate the fail. Its does not immediately appear to be related. |
|
Yes, I can confirm that the fails here are orthogonal; see #972 . |
|
Closed-reopened to re-trigger tests. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fence/indent/dedent code samples in docstrings with proper language tags so that built-in julia help and Documenter.jl can pick them up.