docstrings

Author: Wimmerer

docs/src/arrays.md

@@ -1,14 +1,9 @@
 # GBArrays
 
-There are two datastructures in in `SuiteSparseGraphBLAS.jl`: the `GBVector` and `GBMatrix`.
+There are two primary datastructures in in `SuiteSparseGraphBLAS.jl`: the `GBVector` and `GBMatrix`.
 
 Both types currently implement most of the `AbstractArray` interface and part of the `SparseArrays`
 interface. 
-The goal is to cover the entirety of both (applicable) interfaces as well as `ArrayInterface.jl`
-with the `v1.0` release. 
-
-Most functions accept either type, which is represented by the union 
-`GBArray = {GBVector, GBMatrix, Transpose{<:Any, <:GBMatrix}}`. 
 
 ## Matrix Construction
 ```@setup mat

docs/src/index.md

@@ -53,7 +53,7 @@ GraphBLAS array types are opaque to the user in order to allow the library autho
 SuiteSparse:GraphBLAS takes advantage of this by storing matrices in one of four formats: dense, bitmap, sparse-compressed, or hypersparse-compressed; and in either row or column major orientation.
 
 !!! warning "Default Orientation"
-    The default orientation of a `GBMatrix` is by-row, the opposite of Julia arrays, for speed
+    The default orientation of a `GBMatrix` is by-row, the opposite of Julia arrays, for greater speed
     in certain operations. However, a `GBMatrix` constructed from a `SparseMatrixCSC` or 
     `Matrix` will be stored by-column. This can be changed using `gbset(A, :format, :byrow)`.
 

src/import.jl

@@ -62,7 +62,10 @@ end
 """
     GBMatrix(S::SparseMatrixCSC)
 
-Create a GBMatrix from SparseArrays sparse matrix `S`.
+Create a GBMatrix from a SparseArrays.SparseMatrixCSC `S`.
+
+Note, that unlike other methods of construction, the resulting matrix will be held by column.
+Use `gbset(A, :format, :byrow)` to switch to row orientation.
 """
 function GBMatrix(S::SparseMatrixCSC)
     return GBMatrix{eltype(S)}(_importcscmat(S.m, S.n, S.colptr, S.rowval, S.nzval))

src/matrix.jl

@@ -3,7 +3,7 @@
 """
     GBMatrix{T}(nrows = libgb.GxB_INDEX_MAX, ncols = libgb.GxB_INDEX_MAX)
 
-Create a GBMatrix with the max size.
+Create a GBMatrix of the specified size, defaulting to the maximum on each dimension, 2^60.
 """
 function GBMatrix{T}(nrows = libgb.GxB_INDEX_MAX, ncols = libgb.GxB_INDEX_MAX) where {T}
     GBMatrix{T}(libgb.GrB_Matrix_new(toGBType(T),nrows, ncols))

src/types.jl

@@ -95,7 +95,7 @@ end
 """
     GBMatrix{T} <: AbstractSparseArray{T, UInt64, 2}
 
-TWo-dimensional GraphBLAS array with elements of type T. Internal representation is
+Two-dimensional GraphBLAS array with elements of type T. Internal representation is
 specified as opaque, but in this implementation is stored as one of the following in either
 row or column orientation: