UCP/API: CR comments p2

openucx · Nov 24, 2020 · a3fd63c · a3fd63c
1 parent 26d3040
commit a3fd63c
Showing 1 changed file with 7 additions and 7 deletions.
diff --git a/src/ucp/api/ucp.h b/src/ucp/api/ucp.h
@@ -1420,16 +1420,16 @@ typedef struct {
 
     /**
      * Pointer to the information where received data details are stored
-     * in case of immediate completion of receive operation. User has to provide
-     * a pointer to valid memory/variable which will be updated on function
+     * in case of an immediate completion of receive operation. The user has to
+     * provide a pointer to valid memory/variable which will be updated on function
      * return.
      */
     union {
         size_t              *length;   /* Length of received message in bytes.
                                           Relevant for non-tagged receive
                                           operations. */
-        ucp_tag_recv_info_t *tag_info; /* Information about received message
-                                          relevant for @a ucp_tag_recv_nbx
+        ucp_tag_recv_info_t *tag_info; /* Information about received message.
+                                          Relevant for @a ucp_tag_recv_nbx
                                           function. */
     } recv_info;
 } ucp_request_param_t;
@@ -2824,8 +2824,8 @@ ucs_status_ptr_t ucp_am_send_nbx(ucp_ep_h ep, unsigned id,
  * @return NULL                 - The receive operation was completed
  *                                immediately. In this case, if
  *                                @a param->recv_info.length is specified in the
- *                                @a param, the value pointed by it is updated
- *                                with the size of received message.
+ *                                @a param, the value to which it points is updated
+ *                                with the size of the received message.
  * @return UCS_PTR_IS_ERR(_ptr) - The receive operation failed.
  * @return otherwise            - Receive operation was scheduled and can be
  *                                completed at any point in time. The request
@@ -3393,7 +3393,7 @@ ucs_status_t ucp_tag_recv_nbr(ucp_worker_h worker, void *buffer, size_t count,
  * @return NULL                 - The receive operation was completed
  *                                immediately. In this case, if
  *                                @a param->recv_info.tag_info is specified in the
- *                                @a param, the value pointed by it is updated
+ *                                @a param, the value to which it points is updated
  *                                with the information about the received message.
  * @return UCS_PTR_IS_ERR(_ptr) - The receive operation failed.
  * @return otherwise            - Operation was scheduled for receive. The request