Skip to content

Irecv! Docstring Fix #895

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

Merged
giordano merged 1 commit into from
Mar 26, 2025
+7 −7
Merged

Irecv! Docstring Fix #895

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
14 changes: 7 additions & 7 deletions src/pointtopoint.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,10 +185,10 @@ end
req = Irecv!(recvbuf, comm::Comm[, req::AbstractRequest = Request()];
source::Integer=MPI.ANY_SOURCE, tag::Integer=MPI.ANY_TAG)

Starts a nonblocking receive into the buffer `data` from MPI rank `source` of communicator
`comm` using with the message tag `tag`.
Starts a nonblocking receive into the buffer `recvbuf` from MPI rank `source` of communicator
`comm` using the message tag `tag`.

`data` can be a [`Buffer`](@ref), or any object for which `Buffer(data)` is defined.
`recvbuf` can be a [`Buffer`](@ref), or any object for which `Buffer(recvbuf)` is defined.

Returns the [`AbstractRequest`](@ref) object for the nonblocking receive.

Expand Down Expand Up @@ -343,13 +343,13 @@ isnull(msg::Message) = msg.val == API.MPI_MESSAGE_NULL[]
source::Integer=MPI.ANY_SOURCE, tag::Integer=MPI.ANY_TAG)

Matching non-blocking probe. Similar to [`MPI.Iprobe`](@ref), except that it
also returns `msg`, an [`MPI.Message`](@ref) object.
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) object `msg`,
which must be received by either [`MPI.Mrecv!`](@ref) or [`MPI.Imrecv!`](@ref).
Otherwise `msg` is set to be a null `Message`.

The `Status` argument additionally returns the [`Status`](@ref) of the completed
request.

Expand Down Expand Up @@ -377,12 +377,12 @@ end
source::Integer=MPI.ANY_SOURCE, tag::Integer=MPI.ANY_TAG)

Matching blocking probe. Similar to [`MPI.Probe`](@ref), except that it also
returns `msg`, an [`MPI.Message`](@ref) object.
returns `msg`, an [`MPI.Message`](@ref) object.

Blocks until a message that can be received matching `source`, `tag` and `comm`,
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
request.

Expand Down
Loading