documentation fix

Author: j-fu

.travis.yml

@@ -33,7 +33,7 @@ jobs:
       julia: 1.1
       os: linux
       script:
-        - julia --project=docs/ -e 'using Pkg; println("1"); Pkg.add(PackageSpec(name="DocStringExtensions", version="0.8.0")); println("1a"); Pkg.add("Documenter");  println("2"); Pkg.update(); println("3"); Pkg.develop(PackageSpec(path=pwd())); println("4"); Pkg.instantiate();  println("5");'
+        - julia --project=docs/ -e 'using Pkg;  Pkg.add(PackageSpec(name="DocStringExtensions", version="0.8.0")); Pkg.add("Documenter"); Pkg.update(); Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate();'
         - julia --project=docs/ docs/make.jl
       after_success: skip
 

Manifest.toml

@@ -0,0 +1,79 @@
+# This file is machine-generated - editing it directly is not advised
+
+[[Base64]]
+uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
+
+[[Dates]]
+deps = ["Printf"]
+uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
+
+[[Distributed]]
+deps = ["Random", "Serialization", "Sockets"]
+uuid = "8ba89e20-285c-5b6f-9357-94700520ee1b"
+
+[[DocStringExtensions]]
+deps = ["LibGit2", "Markdown", "Pkg", "Test"]
+git-tree-sha1 = "0513f1a8991e9d83255e0140aace0d0fc4486600"
+uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
+version = "0.8.0"
+
+[[InteractiveUtils]]
+deps = ["Markdown"]
+uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
+
+[[LibGit2]]
+uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
+
+[[Libdl]]
+uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
+
+[[LinearAlgebra]]
+deps = ["Libdl"]
+uuid = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+
+[[Logging]]
+uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
+
+[[Markdown]]
+deps = ["Base64"]
+uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
+
+[[Pkg]]
+deps = ["Dates", "LibGit2", "Markdown", "Printf", "REPL", "Random", "SHA", "UUIDs"]
+uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
+
+[[Printf]]
+deps = ["Unicode"]
+uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
+
+[[REPL]]
+deps = ["InteractiveUtils", "Markdown", "Sockets"]
+uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
+
+[[Random]]
+deps = ["Serialization"]
+uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+
+[[SHA]]
+uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
+
+[[Serialization]]
+uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
+
+[[Sockets]]
+uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
+
+[[SparseArrays]]
+deps = ["LinearAlgebra", "Random"]
+uuid = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
+
+[[Test]]
+deps = ["Distributed", "InteractiveUtils", "Logging", "Random"]
+uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[[UUIDs]]
+deps = ["Random", "SHA"]
+uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
+
+[[Unicode]]
+uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"

docs/src/api.md

@@ -18,9 +18,6 @@ Order = [:constant]
 
 ```@autodocs
 Modules = [ExtendableSparse]
-Pages = ["extension.jl","extendable.jl","sprand.md"]
+Pages = ["extension.jl","extendable.jl", "sprand.jl"]
 Order = [:function]
 ```
-
-
-

src/extendable.jl

@@ -5,7 +5,6 @@ $(TYPEDEF)
 Extendable sparse matrix. A nonzero  entry of this matrix is contained
 either in cscmatrix, or in extmatrix, never in both.
 
-
 $(TYPEDFIELDS)
 """
 mutable struct ExtendableSparseMatrix{Tv,Ti<:Integer} <: AbstractSparseMatrix{Tv,Ti}
@@ -20,21 +19,17 @@ mutable struct ExtendableSparseMatrix{Tv,Ti<:Integer} <: AbstractSparseMatrix{Tv
     extmatrix::SparseMatrixExtension{Tv,Ti}
 end
 
+
 """
 $(TYPEDSIGNATURES)
 
 Create empty ExtendablSparseMatrix.
 
 This is a pendant to spzeros.
-
 """
 ExtendableSparseMatrix{Tv,Ti}(m::Integer, n::Integer) where {Tv,Ti<:Integer}=ExtendableSparseMatrix{Tv,Ti}(spzeros(Tv,Ti,m,n),SparseMatrixExtension{Tv, Ti}(m,n))
 
 
-
-
-
-
 """
 $(TYPEDSIGNATURES)
 
@@ -59,10 +54,8 @@ end
 
 
 
-
-
 """
-$(TYPEDSIGNATURES)
+$(SIGNATURES)
 
 Find index in CSC matrix and set value if it exists. Otherwise,
 set index in extension.
@@ -81,7 +74,7 @@ end
 
 
 """
-$(TYPEDSIGNATURES)
+$(SIGNATURES)
 
 Find index in CSC matrix and return value, if it exists.
 Otherwise, return value from extension.
@@ -95,37 +88,23 @@ function Base.getindex(M::ExtendableSparseMatrix,i::Integer, j::Integer)
     end
 end
 
-
-
-
-
-
 """
-$(TYPEDSIGNATURES)
+$(SIGNATURES)
 
-Matrix size.
+Size of ExtendableSparseMatrix.
 """
 Base.size(E::ExtendableSparseMatrix) = (E.cscmatrix.m, E.cscmatrix.n)
 
 
-
-
-
-
 """
-$(TYPEDSIGNATURES)
+$(SIGNATURES)
 
-Number of nonzeros.
+Number of nonzeros of ExtendableSparseMatrix.
 """
 SparseArrays.nnz(E::ExtendableSparseMatrix)=(nnz(E.cscmatrix)+nnz(E.extmatrix))
 
 
 
-
-
-
-
-
 # Struct holding pair of value and row
 # number, for sorting
 mutable struct ColEntry{Tv,Ti<:Integer}
@@ -221,9 +200,6 @@ function _splice(E::SparseMatrixExtension{Tv,Ti},S::SparseMatrixCSC{Tv,Ti}) wher
 end
 
 
-
-
-
 """
 $(TYPEDSIGNATURES)
 
@@ -240,11 +216,8 @@ end
 
 
 
-
-
-
 """
-$(TYPEDSIGNATURES)
+$(SIGNATURES)
 
 Flush and delegate to cscmatrix.
 """
@@ -257,7 +230,7 @@ end
 
 
 """
-$(TYPEDSIGNATURES)
+$(SIGNATURES)
 
 Flush and delegate to cscmatrix.
 """
@@ -267,11 +240,8 @@ function SparseArrays.rowvals(E::ExtendableSparseMatrix)
 end
 
 
-
-
-
 """
-$(TYPEDSIGNATURES)
+$(SIGNATURES)
 
 Flush and delegate to cscmatrix.
 """
@@ -281,10 +251,8 @@ function xcolptrs(E::ExtendableSparseMatrix)
 end
 
 
-
-
 """
-$(TYPEDSIGNATURES)
+$(SIGNATURES)
 
 Flush and delegate to cscmatrix.
 """
@@ -295,7 +263,7 @@ end
 
 
 """
-$(TYPEDSIGNATURES)
+$(SIGNATURES)
 
 Flush and delegate to cscmatrix.
 """
@@ -320,7 +288,7 @@ end
 
 
 """
-$(TYPEDSIGNATURES)
+$(SIGNATURES)
 
 Flush and delegate to cscmatrix.
 """

src/extension.jl

@@ -1,4 +1,4 @@
-##################################################################
+
 """
 $(TYPEDEF)
 
@@ -25,6 +25,7 @@ mutable struct SparseMatrixExtension{Tv,Ti<:Integer} <: AbstractSparseMatrix{Tv,
     """
     nnz::Ti
 
+
     """
     Linked list of column entries. Initial length is n,
     it grows with each new entry.
@@ -40,7 +41,7 @@ mutable struct SparseMatrixExtension{Tv,Ti<:Integer} <: AbstractSparseMatrix{Tv,
     Row numbers. For each index it contains the zero (initial state)
     or the row numbers corresponding to the column entry list in colptr.
 
-     Initial length is n,
+    Initial length is n,
     it grows with each new entry.
     """
     rowval::Vector{Ti}
@@ -55,6 +56,7 @@ mutable struct SparseMatrixExtension{Tv,Ti<:Integer} <: AbstractSparseMatrix{Tv,
 end
 
 
+
 """
 $(TYPEDSIGNATURES)
     
@@ -66,7 +68,7 @@ SparseMatrixExtension{Tv,Ti}(m::Integer, n::Integer)  where {Tv,Ti<:Integer} =
 
 
 """
-$(TYPEDSIGNATURES)
+$(SIGNATURES)
     
 Return value stored for entry or zero if not found
 """
@@ -90,7 +92,7 @@ end
 
 
 """
-$(TYPEDSIGNATURES)
+$(SIGNATURES)
     
 Update value of existing entry, otherwise extend matrix.
 """
@@ -168,3 +170,4 @@ used in thest methods
 function flush!(M::SparseMatrixExtension{Tv, Ti}) where{Tv, Ti}
     return M
 end
+

src/sprand.jl

@@ -1,5 +1,5 @@
 """
-$(TYPEDSIGNATURES)
+$(SIGNATURES)
 
 Fill empty sparse matrix A with random nonzero elements from interval [1,2]
 using incremental assembly.