Skip to content
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.

Sign up for GitHub

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

Jump to bottom

improve docstring of SparseMatrixCSC #30689

Merged
merged 4 commits into from
Jan 13, 2019
Merged

improve docstring of SparseMatrixCSC #30689

merged 4 commits into from
Jan 13, 2019

Conversation

abraunst
Copy link
Contributor

Give the poor user a hint about constructing these matrices by cross-referencing to spzeros and sparse.

@andreasnoack
Copy link
Member

Maybe even mention explicitly that they are typically constructed with sparse and not SparseMatrixCSC directly.

@abraunst
Copy link
Contributor Author

Maybe even mention explicitly that they are typically constructed with sparse and not SparseMatrixCSC directly.

Something like this?

Matrix type for storing sparse matrices in the [Compressed Sparse Column](@ref man-csc) format.
The standard way of constructing SparseMatrixCSC is through the [`sparse`](@ref) function. See
also [`spzeros`](@ref), [`sprand`](@ref).

@fredrikekre fredrikekre added docs This change adds or pertains to documentation backport pending 1.0 labels Jan 11, 2019
@fredrikekre fredrikekre merged commit 0a6935f into JuliaLang:master Jan 13, 2019
@ViralBShah ViralBShah added the sparse Sparse arrays label Jan 20, 2019
KristofferC pushed a commit that referenced this pull request Feb 11, 2019
@abraunst @KristofferC
improve docstring of SparseMatrixCSC (#30689)
a7f50dc 

(cherry picked from commit 0a6935f)
@KristofferC KristofferC mentioned this pull request Feb 11, 2019
Merged
39 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stevengj stevengj stevengj approved these changes

@StefanKarpinski StefanKarpinski StefanKarpinski approved these changes

Assignees
No one assigned
Labels
docs This change adds or pertains to documentation sparse Sparse arrays
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@abraunst @andreasnoack @StefanKarpinski @stevengj @ViralBShah @JeffBezanson @fredrikekre