Skip to content

Commit

Permalink
Improve comment
Browse files Browse the repository at this point in the history
  • Loading branch information
kingcrimsontianyu committed Jan 20, 2025
1 parent 255dde6 commit 2c9c697
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions cpp/include/kvikio/file_handle.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -247,9 +247,10 @@ class FileHandle {
* in the null stream. When in KvikIO's compatibility mode or when accessing host memory, the
* operation is always default stream ordered like the rest of the non-async CUDA API. In this
* case, the value of `sync_default_stream` is ignored.
* @return Future that on completion returns the size of bytes that were successfully read. The
* future object's wait() or get() should not be called after the lifetime of the FileHandle
* object. Otherwise, the behavior is undefined.
* @return Future that on completion returns the size of bytes that were successfully read.
*
* @note The `std::future` object's `wait()` or `get()` should not be called after the lifetime of
* the FileHandle object. Otherwise, the behavior is undefined.
*/
std::future<std::size_t> pread(void* buf,
std::size_t size,
Expand Down Expand Up @@ -283,9 +284,10 @@ class FileHandle {
* in the null stream. When in KvikIO's compatibility mode or when accessing host memory, the
* operation is always default stream ordered like the rest of the non-async CUDA API. In this
* case, the value of `sync_default_stream` is ignored.
* @return Future that on completion returns the size of bytes that were successfully written. The
* future object's wait() or get() should not be called after the lifetime of the FileHandle
* object. Otherwise, the behavior is undefined.
* @return Future that on completion returns the size of bytes that were successfully written.
*
* @note The `std::future` object's `wait()` or `get()` should not be called after the lifetime of
* the FileHandle object. Otherwise, the behavior is undefined.
*/
std::future<std::size_t> pwrite(const void* buf,
std::size_t size,
Expand Down

0 comments on commit 2c9c697

Please sign in to comment.