[REVIEW] Make documentation uniform for stream and memory resource params

CHANGELOG.md

@@ -200,6 +200,7 @@
 - PR #5213 Documentation enhancements to `cudf` python APIs
 - PR #5251 Fix more mispellings in cpp comments and strings
 - PR #5270 Add support to check for "NaT" and "None" strings while typecasting to `datetime64`
+- PR #5216 Make documentation uniform for params
 
 ## Bug Fixes
 

cpp/include/cudf/binaryop.hpp

@@ -86,7 +86,7 @@ enum class binary_operator : int32_t {
  * @param lhs         The left operand scalar
  * @param rhs         The right operand column
  * @param output_type The desired data type of the output column
- * @param mr          Memory resource for allocating output column
+ * @param mr          Device memory resource used to allocate the returned column's device memory
  * @return            Output column of `output_type` type containing the result of
  *                    the binary operation
  * @throw cudf::logic_error if @p output_type dtype isn't fixed-width
@@ -111,7 +111,7 @@ std::unique_ptr<column> binary_operation(
  * @param lhs         The left operand column
  * @param rhs         The right operand scalar
  * @param output_type The desired data type of the output column
- * @param mr          Memory resource for allocating output column
+ * @param mr          Device memory resource used to allocate the returned column's device memory
  * @return            Output column of `output_type` type containing the result of
  *                    the binary operation
  * @throw cudf::logic_error if @p output_type dtype isn't fixed-width
@@ -134,7 +134,7 @@ std::unique_ptr<column> binary_operation(
  * @param lhs         The left operand column
  * @param rhs         The right operand column
  * @param output_type The desired data type of the output column
- * @param mr          Memory resource for allocating output column
+ * @param mr          Device memory resource used to allocate the returned column's device memory
  * @return            Output column of `output_type` type containing the result of
  *                    the binary operation
  * @throw cudf::logic_error if @p lhs and @p rhs are different sizes
@@ -162,7 +162,7 @@ std::unique_ptr<column> binary_operation(
  * @param output_type The desired data type of the output column. It is assumed
  *                    that output_type is compatible with the output data type
  *                    of the function in the PTX code
- * @param mr          Memory resource for allocating output column
+ * @param mr          Device memory resource used to allocate the returned column's device memory
  * @return            Output column of `output_type` type containing the result of
  *                    the binary operation
  * @throw cudf::logic_error if @p lhs and @p rhs are different sizes

cpp/include/cudf/column/column.hpp

@@ -58,8 +58,8 @@ class column {
    * and copies.
    *
    * @param other The `column` to copy
-   * @param stream The stream on which to execute all allocations and copies
-   * @param mr The resource to use for all allocations
+   * @param stream CUDA stream used for device memory operations.
+   * @param mr Device memory resource to use for all device memory allocations
    */
   column(column const& other,
          cudaStream_t stream,
@@ -113,9 +113,8 @@ class column {
    * This accounts for the `column_view`'s offset.
    *
    * @param view The view to copy
-   * @param stream The stream on which all allocations and copies will be
-   * executed
-   * @param mr The resource to use for all allocations
+   * @param stream CUDA stream used for device memory operations.
+   * @param mr Device memory resource to use for all device memory allocations
    */
   explicit column(column_view view,
                   cudaStream_t stream                 = 0,

cpp/include/cudf/column/column_device_view.cuh

@@ -373,8 +373,7 @@ class alignas(16) column_device_view : public detail::column_device_view_base {
    * A `column_device_view` should be passed by value into GPU kernels.
    *
    * @param source_view The `column_view` to make usable in device code
-   * @param stream optional, stream on which the memory for children will be
-   * allocated
+   * @param stream CUDA stream used for device memory operations for children columns.
    * @return A `unique_ptr` to a `column_device_view` that makes the data from
    *`source_view` available in device memory.
    */
@@ -465,8 +464,7 @@ class alignas(16) mutable_column_device_view : public detail::column_device_view
    * A `mutable_column_device_view` should be passed by value into GPU kernels.
    *
    * @param source_view The `column_view` to make usable in device code
-   * @param stream optional, stream on which the memory for children will be
-   * allocated
+   * @param stream CUDA stream used for device memory operations for children columns.
    * @return A `unique_ptr` to a `mutable_column_device_view` that makes the
    * data from `source_view` available in device memory.
    */

cpp/include/cudf/column/column_factories.hpp

@@ -50,10 +50,8 @@ std::unique_ptr<column> make_empty_column(data_type type);
  * @param[in] size The number of elements in the column
  * @param[in] state Optional, controls allocation/initialization of the
  * column's null mask. By default, no null mask is allocated.
- * @param[in] stream Optional stream on which to issue all memory allocation and
- * device kernels
- * @param[in] mr Optional resource to use for device memory
- * allocation of the column's `data` and `null_mask`.
+ * @param[in] stream CUDA stream used for device memory operations and kernel launches.
+ * @param[in] mr Device memory resource used to allocate the returned column's device memory
  */
 std::unique_ptr<column> make_numeric_column(
   data_type type,
@@ -76,10 +74,8 @@ std::unique_ptr<column> make_numeric_column(
  * @param[in] size The number of elements in the column
  * @param[in] null_mask Null mask to use for this column.
  * @param[in] null_count Optional number of nulls in the null_mask.
- * @param[in] stream Optional stream on which to issue all memory allocation and
- * device kernels
- * @param[in] mr Optional resource to use for device memory
- * allocation of the column's `data` and `null_mask`.
+ * @param[in] stream CUDA stream used for device memory operations and kernel launches.
+ * @param[in] mr Device memory resource used to allocate the returned column's device memory
  */
 template <typename B>
 std::unique_ptr<column> make_numeric_column(
@@ -112,10 +108,8 @@ std::unique_ptr<column> make_numeric_column(
  * @param[in] size The number of elements in the column
  * @param[in] state Optional, controls allocation/initialization of the
  * column's null mask. By default, no null mask is allocated.
- * @param[in] stream Optional stream on which to issue all memory allocation and
- * device kernels
- * @param[in] mr Optional resource to use for device memory
- * allocation of the column's `data` and `null_mask`.
+ * @param[in] stream CUDA stream used for device memory operations and kernel launches.
+ * @param[in] mr Device memory resource used to allocate the returned column's device memory
  */
 std::unique_ptr<column> make_timestamp_column(
   data_type type,
@@ -138,10 +132,8 @@ std::unique_ptr<column> make_timestamp_column(
  * @param[in] size The number of elements in the column
  * @param[in] null_mask Null mask to use for this column.
  * @param[in] null_count Optional number of nulls in the null_mask.
- * @param[in] stream Optional stream on which to issue all memory allocation and
- * device kernels
- * @param[in] mr Optional resource to use for device memory
- * allocation of the column's `data` and `null_mask`.
+ * @param[in] stream CUDA stream used for device memory operations and kernel launches.
+ * @param[in] mr Device memory resource used to allocate the returned column's device memory
  */
 template <typename B>
 std::unique_ptr<column> make_timestamp_column(
@@ -174,10 +166,8 @@ std::unique_ptr<column> make_timestamp_column(
  * @param[in] size The number of elements in the column
  * @param[in] state Optional, controls allocation/initialization of the
  * column's null mask. By default, no null mask is allocated.
- * @param[in] stream Optional stream on which to issue all memory allocation and device
- * kernels
- * @param[in] mr Optional resource to use for device memory
- * allocation of the column's `data` and `null_mask`.
+ * @param[in] stream CUDA stream used for device memory operations and kernel launches.
+ * @param[in] mr Device memory resource used to allocate the returned column's device memory
  */
 std::unique_ptr<column> make_fixed_width_column(
   data_type type,
@@ -200,10 +190,8 @@ std::unique_ptr<column> make_fixed_width_column(
  * @param[in] size The number of elements in the column
  * @param[in] null_mask Null mask to use for this column.
  * @param[in] null_count Optional number of nulls in the null_mask.
- * @param[in] stream Optional stream on which to issue all memory allocation and device
- * kernels
- * @param[in] mr Optional resource to use for device memory
- * allocation of the column's `data` and `null_mask`.
+ * @param[in] stream CUDA stream used for device memory operations and kernel launches.
+ * @param[in] mr Device memory resource used to allocate the returned column's device memory
  */
 template <typename B>
 std::unique_ptr<column> make_fixed_width_column(
@@ -239,10 +227,9 @@ std::unique_ptr<column> make_fixed_width_column(
  * @param strings The vector of pointer/size pairs.
  *                Each pointer must be a device memory address or `nullptr`
  * (indicating a null string). The size must be the number of bytes.
- * @param stream Optional stream for use with all memory allocation
- *               and device kernels
- * @param mr Optional resource to use for device memory
- *           allocation of the column's `null_mask` and children.
+ * @param stream CUDA stream used for device memory operations and kernel launches.
+ * @param mr Device memory resource used for allocation of the column's `null_mask` and children
+ * columns' device memory.
  */
 std::unique_ptr<column> make_strings_column(
   const rmm::device_vector<thrust::pair<const char*, size_type>>& strings,
@@ -271,10 +258,9 @@ std::unique_ptr<column> make_strings_column(
  * bytes.
  * @param null_placeholder string_view indicating null string in given list of
  * string_views.
- * @param stream Optional stream for use with all memory allocation
- *               and device kernels
- * @param mr Optional resource to use for device memory
- *           allocation of the column's `null_mask` and children.
+ * @param stream CUDA stream used for device memory operations and kernel launches.
+ * @param mr Device memory resource used for allocation of the column's `null_mask` and children
+ * columns' device memory.
  */
 std::unique_ptr<column> make_strings_column(
   const rmm::device_vector<string_view>& string_views,
@@ -310,10 +296,9 @@ std::unique_ptr<column> make_strings_column(
  * @param null_count The number of null string entries. If equal to
  * `UNKNOWN_NULL_COUNT`, the null count will be computed dynamically on the
  * first invocation of `column::null_count()`
- * @param stream Optional stream for use with all memory allocation
- *               and device kernels
- * @param mr Optional resource to use for device memory
- *           allocation of the column's `null_mask` and children.
+ * @param stream CUDA stream used for device memory operations and kernel launches.
+ * @param mr Device memory resource used for allocation of the column's `null_mask` and children
+ * columns' device memory.
  */
 std::unique_ptr<column> make_strings_column(
   const rmm::device_vector<char>& strings,
@@ -351,10 +336,9 @@ std::unique_ptr<column> make_strings_column(
  * @param null_count The number of null string entries. If equal to
  * `UNKNOWN_NULL_COUNT`, the null count will be computed dynamically on the
  * first invocation of `column::null_count()`
- * @param stream Optional stream for use with all memory allocation
- *               and device kernels
- * @param mr Optional resource to use for device memory
- *           allocation of the column's `null_mask` and children.
+ * @param stream CUDA stream used for device memory operations and kernel launches.
+ * @param mr Device memory resource used for allocation of the column's `null_mask` and children
+ * columns' device memory.
  */
 std::unique_ptr<column> make_strings_column(
   const std::vector<char>& strings,
@@ -380,10 +364,9 @@ std::unique_ptr<column> make_strings_column(
  * @param null_count The number of null string entries.
  * @param null_mask The bits specifying the null strings in device memory.
  *                  Arrow format for nulls is used for interpeting this bitmask.
- * @param stream Optional stream for use with all memory allocation
- *               and device kernels
- * @param mr Optional resource to use for device memory
- *           allocation of the column's `null_mask` and children.
+ * @param stream CUDA stream used for device memory operations and kernel launches.
+ * @param mr Device memory resource used for allocation of the column's `null_mask` and children
+ * columns' device memory.
  */
 std::unique_ptr<column> make_strings_column(
   size_type num_strings,
@@ -404,9 +387,8 @@ std::unique_ptr<column> make_strings_column(
  *
  * @param s The scalar to use for values in the column.
  * @param size The number of rows for the output column.
- * @param stream Optional stream for use with all memory allocation
- *               and device kernels
- * @param mr Optional resource to use for device memory.
+ * @param stream CUDA stream used for device memory operations and kernel launches.
+ * @param mr Device memory resource used to allocate the returned column's device memory.
  */
 std::unique_ptr<column> make_column_from_scalar(
   scalar const& s,

cpp/include/cudf/concatenate.hpp

@@ -35,8 +35,7 @@ namespace cudf {
  * Returns empty `device_buffer` if the column is not nullable
  *
  * @param views Vector of column views whose bitmask will to be concatenated
- * @param mr Optional, the memory resource that will be used for allocating
- * the device memory for the new device_buffer
+ * @param mr Device memory resource used for allocating the new device_buffer
  * @return rmm::device_buffer A `device_buffer` containing the bitmasks of all
  * the column views in the views vector
  */
@@ -52,7 +51,7 @@ rmm::device_buffer concatenate_masks(
  *
  * @param columns_to_concat The column views to be concatenated into a single
  * column
- * @param mr Optional The resource to use for all allocations
+ * @param mr Device memory resource used to allocate the returned column's device memory.
  * @return Unique pointer to a single table having all the rows from the
  * elements of `columns_to_concat` respectively in the same order.
  */
@@ -83,7 +82,7 @@ std::unique_ptr<column> concatenate(
  *
  * @param tables_to_concat The table views to be concatenated into a single
  * table
- * @param mr Optional The resource to use for all allocations
+ * @param mr Device memory resource used to allocate the returned table's device memory.
  * @return Unique pointer to a single table having all the rows from the
  * elements of `tables_to_concat` respectively in the same order.
  */