Improve comments for format_object

Author: dfalbel

crates/ark/src/data_explorer/format.rs

@@ -82,7 +82,7 @@ fn format_values(x: SEXP, format_options: &FormatOptions) -> anyhow::Result<Vec<
 }
 
 fn format_object(x: SEXP) -> Vec<FormattedValue> {
-    // we call r_format() to dispatch the format method
+    // We call r_format() to dispatch the format method
     let formatted: Vec<String> = match r_format(x) {
         Ok(fmt) => match RObject::from(fmt).try_into() {
             Ok(x) => x,
@@ -91,8 +91,8 @@ fn format_object(x: SEXP) -> Vec<FormattedValue> {
         Err(_) => return unknown_format(x),
     };
 
-    // but we also want to show special value codes. we call base::is.na() to dispatch
-    // the is.na() function and then replace those with FormattedValues::NA.
+    // But we also want to show special value codes. We call `base::is.na()` to dispatch
+    // the `is.na()` function and then replace those with `FormattedValues::NA`.
     let is_na = RFunction::from("is_na_checked")
         .add(x)
         .call_in(ARK_ENVS.positron_ns);
@@ -103,26 +103,26 @@ fn format_object(x: SEXP) -> Vec<FormattedValue> {
                 .into_iter()
                 .zip(unsafe { LogicalVector::new_unchecked(is_na.sexp).iter() })
                 .map(|(v, is_na)| {
-                    // we don't expect is.na to return NA's, but if it happens, we treat it as false
+                    // We don't expect is.na to return NA's, but if it happens, we treat it as false
                     if is_na.unwrap_or(false) {
                         FormattedValue::NA
                     } else {
-                        // base::format defaults to using `trim=FALSE`
-                        // so it will add spaces to the end of the strings so all elements of the vector
-                        // have the same fixed width. We don't want this behavior in the data explorer,
+                        // `base::format` defaults to using `trim=FALSE`
+                        // So it will add spaces to the end of the strings causing all elements of the vector
+                        // to have the same fixed width. We don't want this behavior in the data explorer,
                         // We tried passing `trim=TRUE` but this is unfortunately not supported for eg. `factors`:
                         // > format(factor(c("aaaa", "a")), trim = TRUE)
                         // [1] "aaaa" "a   "
                         //
-                        // so we will just trim the spaces manually, which is not ideal, but it's better than
+                        // So we will just trim the spaces manually, which is not ideal, but it's better than
                         // having the values misaligned
                         FormattedValue::Value(v.trim_matches(|x| x == ' ').to_string())
                     }
                 })
                 .collect()
         },
         Err(_) => {
-            // if we fail to get the is.na() values we will just return the formatted values
+            // If we fail to get the is.na() values we will just return the formatted values
             // without additional treatments.
             formatted.into_iter().map(FormattedValue::Value).collect()
         },