Add docstring example to VecOrMat #38253
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
Fix white space.
logankilpatrick
changed the title
kimikage
reviewed
Nov 1, 2020
Co-authored-by: kimikage <kimikage.ceo@gmail.com>
|
I am a bit borderline on this one. I am not sure about the examples here - if they add much to the explanation. They are not an example of user code, but a demonstration. Wondering what others think? |
|
Revisiting this, I think this is worth merging. But it would be great to have a couple of lines that say what this type is for - a union type that allows functions to accept either a matrix or a vector. It was originally for internal use only - and documentation means we are committing to it, in a way. |
|
@ViralBShah Okay, added. |
|
(Note I originally just opened this since it showed up on the Julia Docs but didn't have a doctoring) |
|
I was also skeptical of this too, but seeing that Viral then approved, I've merged this. |
ElOceanografo
pushed a commit
to ElOceanografo/julia
that referenced
this pull request
May 4, 2021
Co-authored-by: kimikage <kimikage.ceo@gmail.com>
antoine-levitt
pushed a commit
to antoine-levitt/julia
that referenced
this pull request
May 9, 2021
Co-authored-by: kimikage <kimikage.ceo@gmail.com>
johanmon
pushed a commit
to johanmon/julia
that referenced
this pull request
Jul 5, 2021
Co-authored-by: kimikage <kimikage.ceo@gmail.com>
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.
No description provided.