Inconsistent documentation of shmem_wait

open-mpi / ompi

Open MPI main development repository

https://www.open-mpi.org

Other

2.12k stars 856 forks source link

Inconsistent documentation of shmem_wait #7148

Open devreal opened 4 years ago

devreal commented 4 years ago

The documentation for the function shmem_wait seems inconsistent with the function signatures as it describes parameters target, pe, and value that are actually not part of the interface. The parameter ivar is described but at least in the C interface the variable is named var (without the prefix i).

See https://github.com/open-mpi/ompi/blob/master/oshmem/shmem/man/man3/shmem_wait.3in#L91

Ajax-Light commented 2 years ago

Hi, is this still open?

jsquyres commented 2 years ago

Yep!