[GitHub] [arrow-rs] tustvold commented on a diff in pull request #1559: Improve JSON reader documentation

[GitBox <gi...@apache.org>]

tustvold commented on code in PR #1559:
URL: https://github.com/apache/arrow-rs/pull/1559#discussion_r849484468


##########
arrow/src/json/reader.rs:
##########
@@ -555,8 +555,11 @@ where
     generate_schema(field_types)
 }
 
-/// JSON values to Arrow record batch decoder. Decoder's next_batch method takes a JSON Value
-/// iterator as input and outputs Arrow record batch.
+/// JSON values to Arrow record batch decoder.
+///
+/// A [Decoder] decodes arbitrary streams of [serde_json::Value]s and
+/// converts them to [RecordBatch]es. To decode JSON formatted files,
+/// see [Reader].

Review Comment:
   ```suggestion
   /// JSON values to Arrow record batch decoder.
   ///
   /// A [`Decoder`] decodes arbitrary streams of [`serde_json::Value`]s and
   /// converts them to [`RecordBatch`]es. To decode JSON formatted files,
   /// see [`Reader`].
   ```



##########
arrow/src/json/reader.rs:
##########
@@ -664,7 +668,10 @@ impl Decoder {
         }
     }
 
-    /// Read the next batch of records
+    /// Read the next batch of [serde_json::Value] records from the
+    /// interator into a [RecordBatch].

Review Comment:
   ```suggestion
       /// Read the next batch of [`serde_json::Value`] records from the
       /// interator into a [`RecordBatch`].
   ```



##########
arrow/src/json/reader.rs:
##########
@@ -635,8 +638,9 @@ impl DecoderOptions {
 }
 
 impl Decoder {
-    /// Create a new JSON decoder from any value that implements the `Iterator<Item=Result<Value>>`
-    /// trait.
+    /// Create a new JSON decoder from some value that implements an
+    /// iterator over [serde_json::Value]s (aka implements the

Review Comment:
   ```suggestion
       /// iterator over [`serde_json::Value`]s (aka implements the
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org