docs: Improve documentation for collective operations

[swaptr]

Description

Current documentation for communication.Alltoall and communication.Alltoallv does not represent the different construction of sendbuf and recvbuf. Also, the documentation of non-blocking methods for this same are also updated.

Issue/s resolved: #1072

Changes proposed:

• Improve documentation of collective operations.

Type of change

• Documentation update

Memory requirements

NA

Performance

NA

Due Diligence

• All split configurations tested
• Multiple dtypes tested in relevant functions
• Documentation updated (if needed)
• Title of PR is suitable for corresponding CHANGELOG entry

Does this change modify the behaviour of other functions? If so, which?

no

[swaptr]

Force-push for commit cleanup.

[ClaudiaComito]

Thanks a lot @swaptr, this looks so much better!

In the Alltoallv function, will you add the description of sendbuf and recvbuf as tuples of buffer, counts and displacements (type hints and docstrings)? Thanks!

[swaptr]

Thanks for reviewing this @ClaudiaComito . Can you check if its correct now?

[ClaudiaComito]

thanks @swaptr , you're actually validating my impression that the documentation is unclear, so thanks a lot for tackling this.

For Alltoallv, sendbuf and recvbuf must be a tuple of: data object, counts, displacements. Check out the official OpenMPI documentation. Here's another explanation I get back to often as it's easier for me to understand.

Here's an example in our ht.reshape() function

[github-actions]

Thank you for the PR!

[ClaudiaComito]

Hi @swaptr , you can leave this PR open but will you consider allowing us to make changes? We're looking forward to merge your PR. Thanks!