Skip to content
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

Fix typos #850

Merged
merged 1 commit into from
Aug 6, 2024
Merged

Fix typos #850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions src/collective.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -782,7 +782,7 @@ Allreduce(obj::T, op, comm::Comm) where {T} =
Scan!(sendbuf, recvbuf, op, comm::Comm)
Scan!(sendrecvbuf, op, comm::Comm)

Inclusive prefix reduction (analagous to `accumulate` in Julia): `recvbuf` on rank `i`
Inclusive prefix reduction (analogous to `accumulate` in Julia): `recvbuf` on rank `i`
will contain the result of reducing `sendbuf` by `op` from ranks `0:i`.

If only a single buffer `sendrecvbuf` is provided, then operations will be performed
Expand Down Expand Up @@ -813,7 +813,7 @@ Scan!(buf, op, comm::Comm) =
"""
recvbuf = Scan(sendbuf, op, comm::Comm)

Inclusive prefix reduction (analagous to `accumulate` in Julia): `recvbuf` on rank `i`
Inclusive prefix reduction (analogous to `accumulate` in Julia): `recvbuf` on rank `i`
will contain the result of reducing `sendbuf` by `op` from ranks `0:i`.

`sendbuf` can also be a scalar, in which case `recvbuf` will also be a scalar of the same
Expand All @@ -837,7 +837,7 @@ Scan(object::T, op, comm::Comm) where {T} = Scan!(Ref(object), Ref{T}(), op, com
Exscan!(sendbuf, recvbuf, op, comm::Comm)
Exscan!(sendrecvbuf, op, comm::Comm)

Exclusive prefix reduction (analagous to `accumulate` in Julia): `recvbuf` on rank `i`
Exclusive prefix reduction (analogous to `accumulate` in Julia): `recvbuf` on rank `i`
will contain the result of reducing `sendbuf` by `op` from ranks `0:i-1`. The
`recvbuf` on rank `0` is ignored, and the `recvbuf` on rank `1` will contain the contents
of `sendbuf` on rank `0`.
Expand Down Expand Up @@ -869,7 +869,7 @@ Exscan!(buf, op, comm::Comm) = Exscan!(IN_PLACE, buf, op, comm)
"""
recvbuf = Exscan(sendbuf, op, comm::Comm)

Exclusive prefix reduction (analagous to `accumulate` in Julia): `recvbuf` on rank `i`
Exclusive prefix reduction (analogous to `accumulate` in Julia): `recvbuf` on rank `i`
will contain the result of reducing `sendbuf` by `op` from ranks `0:i-1`. The
`recvbuf` on rank `0` is undefined, and the `recvbuf` on rank `1` will contain the contents
of `sendbuf` on rank `0`.
Expand Down
2 changes: 1 addition & 1 deletion src/environment.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ It is unaffected by [`MPI.Finalize`](@ref), and is one of the few functions that
called before [`MPI.Init`](@ref).

# External links
$(_doc_external("MPI_Intialized"))
$(_doc_external("MPI_Initialized"))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ugh, maybe we should have a check for the documentation that links aren't broken 😕

Copy link
Member Author

@lcw lcw Aug 5, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there an option in Documenter.jl for that?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apparently yes: #856. But MPICH/OpenMPI websites aren't reliable for actually documenting all functions... So the reality is that we do have a large number of broken links 😞

"""
function Initialized()
flag = Ref{Cint}()
Expand Down
4 changes: 2 additions & 2 deletions src/pointtopoint.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ Matching non-blocking probe. Similar to [`MPI.Iprobe`](@ref), except that it
also returns `msg`, an [`MPI.Message`](@ref) object.

Checks if there is a message that can be received matching `source`, `tag` and
`comm`. If so, returns `ismsg = true`, and a [`Message`](@ref) objec `msg`,
`comm`. If so, returns `ismsg = true`, and a [`Message`](@ref) object `msg`,
which must be received by either [`MPI.Mrecv!`](@ref) or [`MPI.Imrecv!`](@ref).
Otherwise `msg` is set to be a null `Message`.

Expand Down Expand Up @@ -380,7 +380,7 @@ Matching blocking probe. Similar to [`MPI.Probe`](@ref), except that it also
returns `msg`, an [`MPI.Message`](@ref) object.

Blocks until a message that can be received matching `source`, `tag` and `comm`,
returning a [`Message`](@ref) objec `msg`, which must be received by either
returning a [`Message`](@ref) object `msg`, which must be received by either
[`MPI.Mrecv!`](@ref) or [`MPI.Imrecv!`](@ref).

The `Status` argument additionally returns the [`Status`](@ref) of the completed
Expand Down
Loading