From 67530ea661ae2a887a6bd621953183fa6b6e5fd6 Mon Sep 17 00:00:00 2001 From: Sasindu Alahakoon Date: Tue, 20 Aug 2024 10:13:43 +0530 Subject: [PATCH] Update csv api doc comments --- ballerina/csv_api.bal | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/ballerina/csv_api.bal b/ballerina/csv_api.bal index 292e335..66527eb 100644 --- a/ballerina/csv_api.bal +++ b/ballerina/csv_api.bal @@ -37,6 +37,7 @@ public isolated function parseString(string csvString, ParseOptions options = {} # Converts byte[] to subtype of `record{}[]` or `anydata[][]`. # ```ballerina # byte[] csvBytes = check io:fileReadBytes("example.csv"); +# # record{int id; string name;}[] csv1 = check csv:parseBytes(csvBytes); # [int, string][] csv2 = check csv:parseBytes(csvBytes); # record{|int id;|}[] csv3 = check csv:parseBytes(csvBytes); @@ -54,10 +55,13 @@ public isolated function parseBytes(byte[] csvBytes, ParseOptions options = {}, # ```ballerina # stream csvByteStream = check io:fileReadBlocksAsStream("example.csv"); # record{int id; string name;}[] csv1 = check csv:parseStream(csvByteStream); +# # stream csvByteStream2 = check io:fileReadBlocksAsStream("example.csv"); # [int, string][] csv2 = check csv:parseStream(csvByteStream2); +# # stream csvByteStream3 = check io:fileReadBlocksAsStream("example.csv"); # record{|int id;|}[] csv3 = check csv:parseStream(csvByteStream3); +# # stream csvByteStream4 = check io:fileReadBlocksAsStream("example.csv"); # record{int id;}[] csv4 = check csv:parseStream(csvByteStream4, {skipLines: [1]}); # ```