Fix comment typo in buffer_register (#669)

JigaoLuo · web-flow · commit 6165e62b340a · 2025-03-18T21:07:27.000Z
- No code change - Only typo fix in function signature comment: should be `@param size` instead of `@param length` https://github.com/rapidsai/kvikio/blob/93a447f451dba0b1777be8753f4e4d180c40643b/cpp/include/kvikio/buffer.hpp#L26-L41 Authors: - Jigao Luo (https://github.com/JigaoLuo) - Vukasin Milovanovic (https://github.com/vuule) Approvers: - Bradley Dice (https://github.com/bdice) URL: #669
diff --git a/cpp/include/kvikio/buffer.hpp b/cpp/include/kvikio/buffer.hpp
@@ -24,7 +24,7 @@ namespace kvikio {
  * GPUDirect Storage access.
  *
  * @param devPtr_base  device pointer to allocated
- * @param length  size of memory region from the above specified devPtr
+ * @param size  size of memory region from the above specified devPtr
  * @param flags   should be zero or `CU_FILE_RDMA_REGISTER` (experimental)
  * @param errors_to_ignore  CuFile errors to ignore such as `CU_FILE_MEMORY_ALREADY_REGISTERED`
  * or `CU_FILE_INVALID_MAPPING_SIZE`

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ namespace kvikio {`
`24`	`24`	`* GPUDirect Storage access.`
`25`	`25`	`*`
`26`	`26`	`* @param devPtr_base device pointer to allocated`
`27`		`- * @param length size of memory region from the above specified devPtr`
	`27`	`+ * @param size size of memory region from the above specified devPtr`
`28`	`28`	* @param flags should be zero or `CU_FILE_RDMA_REGISTER` (experimental)
`29`	`29`	* @param errors_to_ignore CuFile errors to ignore such as `CU_FILE_MEMORY_ALREADY_REGISTERED`
`30`	`30`	* or `CU_FILE_INVALID_MAPPING_SIZE`