Skip to content

Commit c9e8550

Browse files
fix documentation
1 parent 3481e71 commit c9e8550

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

src/Context_Methods.jl

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ import Printf.@printf
33
"""
44
GrB_init(mode)
55
6-
GrB_init must called before any other GraphBLAS operation.
7-
GrB_init defines the mode that GraphBLAS will use: blocking or non-blocking.
6+
`GrB_init` must called before any other GraphBLAS operation.
7+
`GrB_init` defines the mode that GraphBLAS will use: blocking or non-blocking.
88
With blocking mode, all operations finish before returning to the user application.
99
With non-blocking mode, operations can be left pending, and are computed only when needed.
1010
"""
@@ -15,8 +15,8 @@ end
1515
"""
1616
GrB_wait()
1717
18-
GrB_wait forces all pending operations to complete.
19-
Blocking mode is as if GrB_wait is called whenever a GraphBLAS method or operation returns to the user.
18+
`GrB_wait` forces all pending operations to complete.
19+
Blocking mode is as if `GrB_wait` is called whenever a GraphBLAS method or operation returns to the user.
2020
"""
2121
function GrB_wait()
2222
return GrB_Info(ccall(dlsym(graphblas_lib, "GrB_wait"), Cint, (), ))
@@ -25,8 +25,8 @@ end
2525
"""
2626
GrB_finalize()
2727
28-
GrB_finalize must be called as the last GraphBLAS operation.
29-
GrB_finalize does not call GrB_wait; any pending computations are abandoned.
28+
`GrB_finalize` must be called as the last GraphBLAS operation.
29+
`GrB_finalize` does not call `GrB_wait`; any pending computations are abandoned.
3030
"""
3131
function GrB_finalize()
3232
return GrB_Info(ccall(dlsym(graphblas_lib, "GrB_finalize"), Cint, (), ))
@@ -35,8 +35,8 @@ end
3535
"""
3636
GrB_error()
3737
38-
Each GraphBLAS method and operation returns a GrB_Info error code.
39-
GrB_error returns additional information on the error.
38+
Each GraphBLAS method and operation returns a `GrB_Info` error code.
39+
`GrB_error` returns additional information on the error.
4040
4141
# Examples
4242
```jldoctest

0 commit comments

Comments
 (0)