Skip to content

Remove extraneous quotes in docstrings #457

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

Merged
merged 2 commits into from
Oct 14, 2023
Merged

Remove extraneous quotes in docstrings #457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82f569a
Remove extraneous quotes in docstrings
jishnub Oct 13, 2023
d60cce2
remove quotes for FixedSparseVector
jishnub Oct 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/sparsematrix.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Creates an empty sparse matrix with element type `Tv` and integer type `Ti` of s
SparseMatrixCSC{Tv,Ti}(::UndefInitializer, m::Integer, n::Integer) where {Tv, Ti} = spzeros(Tv, Ti, m, n)

"""
`FixedSparseCSC{Tv,Ti<:Integer} <: AbstractSparseMatrixCSC{Tv,Ti}`
FixedSparseCSC{Tv,Ti<:Integer} <: AbstractSparseMatrixCSC{Tv,Ti}

Experimental AbstractSparseMatrixCSC whose non-zero index are fixed.
"""
Expand Down Expand Up @@ -94,21 +94,21 @@ FixedSparseCSC{Tv,Ti}(x::AbstractSparseMatrixCSC) where {Tv,Ti} =
getcolptr(x), rowvals(x), nonzeros(x))

"""
`fixed(x...)`
fixed(x...)

Experimental. Like `sparse` but returns a sparse array whose `_is_fixed` is `true`.
"""
fixed(x...) = move_fixed(sparse(x...))
fixed(x::AbstractSparseMatrixCSC) = FixedSparseCSC(x)

"""
`move_fixed(x::AbstractSparseMatrixCSC)`
move_fixed(x::AbstractSparseMatrixCSC)

Experimental, unsafe. Make a `FixedSparseCSC` by reusing the colptr, rowvals and nonzeros of `x`.
"""
move_fixed(x::AbstractSparseMatrixCSC) = FixedSparseCSC(size(x)..., getcolptr(x), rowvals(x), nonzeros(x))
"""
`_unsafe_unfix(x)`
_unsafe_unfix(x)

Experimental, unsafe. Returns a modifiable version of `x` for compatibility with this codebase.
"""
Expand All @@ -118,7 +118,7 @@ _unsafe_unfix(x::SparseMatrixCSC) = x
const SorF = Union{<:SparseMatrixCSC, <:FixedSparseCSC}

"""
`SparseMatrixCSC(x::FixedSparseCSC)`
SparseMatrixCSC(x::FixedSparseCSC)

Get a writable copy of x. See `_unsafe_unfix(x)`
"""
Expand Down
2 changes: 1 addition & 1 deletion src/sparsevector.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ SparseVector(n::Integer, nzind::Vector{Ti}, nzval::Vector{Tv}) where {Tv,Ti} =
SparseVector{Tv, Ti}(::UndefInitializer, n::Integer) where {Tv, Ti} = SparseVector{Tv, Ti}(n, Ti[], Tv[])

"""
`FixedSparseVector{Tv,Ti<:Integer} <: AbstractCompressedVector{Tv,Ti}`
FixedSparseVector{Tv,Ti<:Integer} <: AbstractCompressedVector{Tv,Ti}

Experimental AbstractCompressedVector whose non-zero index are fixed.
"""
Expand Down