Skip to content

Commit cafcc04

Browse files
authored
Various fixes to documentation (#520)
Fix missing docstrings and broken references in docstrings.
1 parent d15a515 commit cafcc04

8 files changed

+28
-27
lines changed

docs/src/advanced.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ MPI.free
1010

1111
```@docs
1212
MPI.Datatype
13+
MPI.to_type
1314
MPI.Types.extent
1415
MPI.Types.create_contiguous
1516
MPI.Types.create_vector
@@ -40,4 +41,3 @@ MPI.ErrorHandler
4041
MPI.get_errorhandler
4142
MPI.set_errorhandler!
4243
```
43-

docs/src/collective.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ MPI.Allgatherv!
3131

3232
```@docs
3333
MPI.Scatter!
34+
MPI.Scatter
3435
MPI.Scatterv!
3536
```
3637

@@ -40,7 +41,6 @@ MPI.Scatterv!
4041
MPI.Alltoall!
4142
MPI.Alltoall
4243
MPI.Alltoallv!
43-
MPI.Alltoallv
4444
```
4545

4646
## Reduce/Scan

docs/src/onesided.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
MPI.Win_create
55
MPI.Win_create_dynamic
66
MPI.Win_allocate_shared
7+
MPI.Win_shared_query
78
MPI.Win_flush
89
MPI.Win_lock
910
MPI.Win_unlock

docs/src/pointtopoint.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44

55
```@docs
66
MPI.Request
7+
MPI.RequestSet
78
MPI.Status
9+
MPI.StatusRef
810
```
911

1012
### Accessors
@@ -37,14 +39,14 @@ MPI.Irecv!
3739
### Completion
3840

3941
```@docs
40-
MPI.Test!
41-
MPI.Testall!
42-
MPI.Testany!
43-
MPI.Testsome!
44-
MPI.Wait!
45-
MPI.Waitall!
46-
MPI.Waitany!
47-
MPI.Waitsome!
42+
MPI.Test
43+
MPI.Testall
44+
MPI.Testany
45+
MPI.Testsome
46+
MPI.Wait
47+
MPI.Waitall
48+
MPI.Waitany
49+
MPI.Waitsome
4850
```
4951

5052
### Probe/Cancel
@@ -53,4 +55,4 @@ MPI.Waitsome!
5355
MPI.Cancel!
5456
MPI.Iprobe
5557
MPI.Probe
56-
```
58+
```

src/collective.jl

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ if the length can be determined from `sendbuf`. On non-root processes it is igno
315315
can be `nothing`.
316316
317317
# See also
318-
- [`Gatherv`](@ref) for the allocating operation
318+
- [`Gatherv!`](@ref) for the allocating operation
319319
- [`Gather!`](@ref)
320320
- [`Allgatherv!`](@ref) to send the result to all processes
321321
@@ -432,7 +432,6 @@ If only one buffer `sendrecvbuf` is provided, then for each process, the data to
432432
is taken from the interval of `recvbuf` where it would store its own data.
433433
434434
# See also
435-
- [`Allgatherv`](@ref) for the allocating operation
436435
- [`Gatherv!`](@ref) to send the result to a single process
437436
438437
# External links

src/datatypes.jl

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,13 @@ function create_resized!(newtype::Datatype, oldtype::Datatype, lb::Integer, exte
372372
return newtype
373373
end
374374

375+
function duplicate!(newtype::Datatype, oldtype::Datatype)
376+
# int MPI_Type_dup(MPI_Datatype oldtype, MPI_Datatype * newtype)
377+
@mpichk ccall((:MPI_Type_dup, libmpi), Cint,
378+
(MPI_Datatype, Ptr{MPI_Datatype}),
379+
oldtype, newtype)
380+
return newtype
381+
end
375382
"""
376383
MPI.Types.duplicate(oldtype::Datatype)
377384
@@ -380,13 +387,6 @@ Duplicates the datatype `oldtype`.
380387
# External links
381388
$(_doc_external("MPI_Type_dup"))
382389
"""
383-
function duplicate!(newtype::Datatype, oldtype::Datatype)
384-
# int MPI_Type_dup(MPI_Datatype oldtype, MPI_Datatype * newtype)
385-
@mpichk ccall((:MPI_Type_dup, libmpi), Cint,
386-
(MPI_Datatype, Ptr{MPI_Datatype}),
387-
oldtype, newtype)
388-
return newtype
389-
end
390390
duplicate(oldtype::Datatype) = duplicate!(Datatype(), oldtype::Datatype)
391391

392392
"""

src/environment.jl

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ An Enum denoting the level of threading support in the current process:
134134
135135
# See also
136136
137-
- [`Init_thread`](@ref)
137+
- [`Init`](@ref)
138138
- [`Query_thread`](@ref)
139139
"""
140140
@enum ThreadLevel begin
@@ -200,12 +200,12 @@ end
200200
"""
201201
Finalize()
202202
203-
Marks MPI state for cleanup. This should be called after [`MPI.Init`](@ref) or
204-
[`MPI.Init_thread`](@ref), and can be called at most once. No further MPI calls (other
205-
than [`Initialized`](@ref) or [`Finalized`](@ref)) should be made after it is called.
203+
Marks MPI state for cleanup. This should be called after [`MPI.Init`](@ref), and
204+
can be called at most once. No further MPI calls (other than
205+
[`Initialized`](@ref) or [`Finalized`](@ref)) should be made after it is called.
206206
207-
[`MPI.Init`](@ref) and [`MPI.Init_thread`](@ref) will automatically insert a hook to
208-
call this function when Julia exits, if it hasn't already been called.
207+
[`MPI.Init`](@ref) will automatically insert a hook to call this function when
208+
Julia exits, if it hasn't already been called.
209209
210210
# External links
211211
$(_doc_external("MPI_Finalize"))

src/nonblocking.jl

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -528,4 +528,3 @@ function Cancel!(req::Request)
528528
@mpichk ccall((:MPI_Cancel, libmpi), Cint, (Ptr{MPI_Request},), req)
529529
nothing
530530
end
531-

0 commit comments

Comments
 (0)