From 6fb5fd842648d36a23d1e5c6a22f74b142ca2850 Mon Sep 17 00:00:00 2001 From: Alfredo Braunstein Date: Fri, 11 Jan 2019 16:41:27 +0100 Subject: [PATCH 1/4] enhance documentation of SparseMatrixCSC --- stdlib/SparseArrays/src/sparsematrix.jl | 1 + 1 file changed, 1 insertion(+) diff --git a/stdlib/SparseArrays/src/sparsematrix.jl b/stdlib/SparseArrays/src/sparsematrix.jl index baac93ca15b2f..26a01938c48dc 100644 --- a/stdlib/SparseArrays/src/sparsematrix.jl +++ b/stdlib/SparseArrays/src/sparsematrix.jl @@ -10,6 +10,7 @@ Matrix type for storing sparse matrices in the [Compressed Sparse Column](@ref man-csc) format. +See also [`spzeros`](@ref) and [`sparse`](@ref). """ struct SparseMatrixCSC{Tv,Ti<:Integer} <: AbstractSparseMatrix{Tv,Ti} m::Int # Number of rows From 9e247f101a5aeb2229455e587db62c996756155b Mon Sep 17 00:00:00 2001 From: Alfredo Braunstein Date: Fri, 11 Jan 2019 19:37:38 +0100 Subject: [PATCH 2/4] Better docstring [skip ci] --- stdlib/SparseArrays/src/sparsematrix.jl | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/stdlib/SparseArrays/src/sparsematrix.jl b/stdlib/SparseArrays/src/sparsematrix.jl index 26a01938c48dc..b685903068030 100644 --- a/stdlib/SparseArrays/src/sparsematrix.jl +++ b/stdlib/SparseArrays/src/sparsematrix.jl @@ -10,7 +10,9 @@ Matrix type for storing sparse matrices in the [Compressed Sparse Column](@ref man-csc) format. -See also [`spzeros`](@ref) and [`sparse`](@ref). +The standard way of constructing SparseMatrixCSC +is through the [`sparse`](@ref) function. See +also [`spzeros`](@ref), [`sprand`](@ref). """ struct SparseMatrixCSC{Tv,Ti<:Integer} <: AbstractSparseMatrix{Tv,Ti} m::Int # Number of rows From 36b7b2e5557f744759dafc4900830252df97092d Mon Sep 17 00:00:00 2001 From: Alfredo Braunstein Date: Sat, 12 Jan 2019 08:09:31 +0100 Subject: [PATCH 3/4] better style --- stdlib/SparseArrays/src/sparsematrix.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/stdlib/SparseArrays/src/sparsematrix.jl b/stdlib/SparseArrays/src/sparsematrix.jl index b685903068030..2e1ac2b183522 100644 --- a/stdlib/SparseArrays/src/sparsematrix.jl +++ b/stdlib/SparseArrays/src/sparsematrix.jl @@ -12,7 +12,7 @@ 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). +also [`spzeros`](@ref) and [`sprand`](@ref). """ struct SparseMatrixCSC{Tv,Ti<:Integer} <: AbstractSparseMatrix{Tv,Ti} m::Int # Number of rows From a874f0443fe486589b67f73bf6d395decf6d6ebd Mon Sep 17 00:00:00 2001 From: Alfredo Braunstein Date: Sun, 13 Jan 2019 01:52:22 +0100 Subject: [PATCH 4/4] add cross-reference to spdiagm --- stdlib/SparseArrays/src/sparsematrix.jl | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/stdlib/SparseArrays/src/sparsematrix.jl b/stdlib/SparseArrays/src/sparsematrix.jl index 2e1ac2b183522..903294c6920fd 100644 --- a/stdlib/SparseArrays/src/sparsematrix.jl +++ b/stdlib/SparseArrays/src/sparsematrix.jl @@ -9,10 +9,9 @@ SparseMatrixCSC{Tv,Ti<:Integer} <: AbstractSparseMatrix{Tv,Ti} 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) and [`sprand`](@ref). +[Compressed Sparse Column](@ref man-csc) format. The standard way +of constructing SparseMatrixCSC is through the [`sparse`](@ref) function. +See also [`spzeros`](@ref), [`spdiagm`](@ref) and [`sprand`](@ref). """ struct SparseMatrixCSC{Tv,Ti<:Integer} <: AbstractSparseMatrix{Tv,Ti} m::Int # Number of rows