Apply suggestions from code review

Co-authored-by: Bradley Dice <bdice@bradleydice.com>
Co-authored-by: Lawrence Mitchell <wence@gmx.li>

cpp/CMakeLists.txt

@@ -36,7 +36,7 @@ rapids_cmake_write_version_file(include/kvikio/version_config.hpp)
 rapids_cmake_build_type(Release)
 
 # build options
-option(KvikIO_REMOTE_SUPPORT "Configure CMake to build with remote io support" ON)
+option(KvikIO_REMOTE_SUPPORT "Configure CMake to build with remote IO support" ON)
 option(KvikIO_BUILD_EXAMPLES "Configure CMake to build examples" ON)
 option(KvikIO_BUILD_TESTS "Configure CMake to build tests" ON)
 

cpp/include/kvikio/remote_handle.hpp

@@ -58,7 +58,7 @@ inline std::size_t callback_host_memory(char* data,
                                         void* context)
 {
   auto ctx                 = reinterpret_cast<CallbackContext*>(context);
-  const std::size_t nbytes = size * nmemb;
+  std::size_t const nbytes = size * nmemb;
   if (ctx->size < ctx->offset + nbytes) {
     ctx->overflow_error = true;
     return CURL_WRITEFUNC_ERROR;
@@ -107,10 +107,10 @@ inline std::size_t callback_device_memory(char* data,
 /**
  * @brief Abstract base class for remote endpoints.
  *
- * In this context, an endpoint refers to a remote file using a specify communication protocol.
+ * In this context, an endpoint refers to a remote file using a specific communication protocol.
  *
  * Each communication protocol, such as HTTP or S3, needs to implement this ABC and implement
- * their own ctor that takes communication protocol specific arguments.
+ * its own ctor that takes communication protocol specific arguments.
  */
 class RemoteEndpoint {
  public:
@@ -159,7 +159,7 @@ class RemoteHandle {
   /**
    * @brief Create a new remote handle from an endpoint and a file size.
    *
-   * @param endpoint Remote endpoint used for subsequently IO.
+   * @param endpoint Remote endpoint used for subsequent IO.
    * @param nbytes The size of the remote file (in bytes).
    */
   RemoteHandle(std::unique_ptr<RemoteEndpoint> endpoint, std::size_t nbytes)

cpp/include/kvikio/shim/libcurl.hpp

@@ -57,7 +57,7 @@ namespace kvikio {
  */
 class LibCurl {
  public:
-  // We hold an unique pointer to the raw curl handle and sets `curl_easy_cleanup` as its Deleter.
+  // We hold a unique pointer to the raw curl handle and set `curl_easy_cleanup` as its Deleter.
   using UniqueHandlePtr = std::unique_ptr<CURL, std::function<void(CURL*)>>;
 
  private:
@@ -137,7 +137,7 @@ class LibCurl {
  * @brief Representation of a curl easy handle pointer and its operations.
  *
  * An instance is given a `LibCurl::UniqueHandlePtr` on creation, which is
- * later retailed on destruction.
+ * later retained on destruction.
  */
 class CurlHandle {
  private:
@@ -152,7 +152,7 @@ class CurlHandle {
    *
    * Typically, do not use this directly instead use the `create_curl_handle()` macro.
    *
-   * @param handle An unused curl easy handle pointer, which is retailed on destruction.
+   * @param handle An unused curl easy handle pointer, which is retained on destruction.
    * @param source_file Path of source file of the caller (for error messages).
    * @param source_line Line of source file of the caller (for error messages).
    */