Skip to content

Commit 859c93a

Browse files
committed
Docs format update
1 parent 937a914 commit 859c93a

29 files changed

+43
-43
lines changed

docs/api/enumerations/escapetype.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Provides a list of constants for use to configure the char used as escape one.
2828
*variable* = `EscapeType`.*Constant*
2929

3030
>📝**Note**
31-
>{: .text-grey-dk-300 .bg-green-000 }
31+
>{: .text-grey-lt-000 .bg-green-000 }
3232
>The `EscapeType.NullChar` value is used with the`QuotationMode.All` setting to indicates the CSV file does not use any escape char in its whole length. This values combination conduces the CSV file to be parse/write assuming the `FieldsDelimiter` property is enough for the import/export operations.
3333
>
3434
>In the case the `FieldsDelimiter` property is not enough for successfully done the import/export operations, the `EscapeType.DoubleQuotes` value would be used for parse/write an CSV having fields to be escaped with double quote and the `EscapeType.Apostrophe` values for parse/write an CSV having fields to be escaped with the apostrophe, using the `QuotationMode.Critical` mode.

docs/api/enumerations/quotationmode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Provides a list of constants to configure the CSV parsing/writing operation beha
2727
*variable* = `QuotationMode`.*Constant*
2828

2929
>📝**Note**
30-
>{: .text-grey-dk-300 .bg-green-000 }
30+
>{: .text-grey-lt-000 .bg-green-000 }
3131
>The `QuotationMode.Critical` value, default one, is used to indicates the CSV file must use escape char only in fields having special char. The `QuotationMode.All` value most be used for those CSV files in wich all its fields will be escaped with the escape char given with the `EscapeChar` property.
3232
{: .text-grey-dk-300 .bg-grey-lt-000 }
3333

docs/api/methods/dumptoarray.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The required *OutPutArray* argument is an identifier specifying a dynamic `Strin
2626
_None_
2727

2828
>📝**Note**
29-
>{: .text-grey-dk-300 .bg-green-000 }
29+
>{: .text-grey-lt-000 .bg-green-000 }
3030
>Before dump data, is recommended to make a `ImportFromCSV` or `ImportFromCSVstring` method call. The *OutPutArray* parameter must be declared as dynamic `String` array. If user forget to do this, an error will occur.
3131
{: .text-grey-dk-300 .bg-grey-lt-000 }
3232

docs/api/methods/dumptosheet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Dumps the data from the current instance to an Excel WorkSheet.
5050
_None_
5151

5252
>📝**Note**
53-
>{: .text-grey-dk-300 .bg-green-000 }
53+
>{: .text-grey-lt-000 .bg-green-000 }
5454
>Before dump data, is recommended to make a `ImportFromCSV` or `ImportFromCSVstring` method call.
5555
{: .text-grey-dk-300 .bg-grey-lt-000 }
5656

docs/api/methods/exporttocsv.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The required *csvArray* argument is an identifier specifying a `Variant` array v
2626
_None_
2727

2828
>📝**Note**
29-
>{: .text-grey-dk-300 .bg-green-000 }
29+
>{: .text-grey-lt-000 .bg-green-000 }
3030
>Before invoke the `ExportToCSV` method, the user must to open a connection to the CSV file. The *csvArray* parameter must be declared as `Variant` array. Passing a variable that isn't an array will cause an error and the operation aborts.
3131
{: .text-grey-dk-300 .bg-grey-lt-000 }
3232

docs/api/methods/getdatafromcsv.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The required *csvPathAndFilename* argument is an identifier specifying a `String
2626
*Type*: `String`
2727

2828
>📝**Note**
29-
>{: .text-grey-dk-300 .bg-green-000 }
29+
>{: .text-grey-lt-000 .bg-green-000 }
3030
>The *csvPathAndFilename* parameter must be the full path to the target CSV file, this means, the parameter holds the folder path, the file name and the ".csv" extension.
3131
{: .text-grey-dk-300 .bg-grey-lt-000 }
3232

docs/api/methods/importfromcsv.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Imports a CSV file's content to an array.
4343
_None_
4444

4545
>📝**Note**
46-
>{: .text-grey-dk-300 .bg-green-000 }
46+
>{: .text-grey-lt-000 .bg-green-000 }
4747
>If the *HeadersOmission* parameter is set to `True`, the CSV file headers, first record, will be ignored by the parser only when the `StartingRecord` property is set to 1.
4848
>The *PassControlToOS* parameter allows user to pass control to the operating system. Control is returned after the operating system has finished processing the events in its queue.
4949
{: .text-grey-dk-300 .bg-grey-lt-000 }
@@ -58,7 +58,7 @@ See also
5858
User can set `CommentLineIndicator` for those CSV files having a combination of empties lines, blanks lines or commented ones for parse the file ONLY when the parser is working on `QuotationMode.Critical` mode. In that mode, the cited lines are simply skipped, leaving no empty values between records separated by this kind of lines. In other words, if the CSV file holds a record and then some special lines (blank, empty or commented) and then another record, the second record will be saved contiguous to the first record ignoring the lines between both.
5959

6060
>⚠️**Caution**
61-
>{: .text-grey-dk-300 .bg-green-000 }
61+
>{: .text-grey-lt-000 .bg-green-000 }
6262
>Before invoke the `ImportFromCSV` method, the user must to open a connection to the CSV file. If the CSV file has no data, this is the file is an empty one, the `ImportFromCSV` method returns an empty array, that is, an array bounded from 0 to -1 and holding no elements and no data.
6363
{: .text-grey-dk-300 .bg-yellow-000 }
6464

docs/api/methods/importfromcsvstring.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Parses a string and save its CSV data to an array.
4747
_None_
4848

4949
>📝**Note**
50-
>{: .text-grey-dk-300 .bg-green-000 }
50+
>{: .text-grey-lt-000 .bg-green-000 }
5151
>If the *HeadersOmission* parameter is set to `True`, the CSV file headers, first record, will be ignored by the parser only when the `StartingRecord` property is set to 1.
5252
>The *PassControlToOS* parameter allows user to pass control to the operating system. Control is returned after the operating system has finished processing the events in its queue.
5353
{: .text-grey-dk-300 .bg-grey-lt-000 }
@@ -62,7 +62,7 @@ See also
6262
User can set `CommentLineIndicator` for those CSV files having a combination of empties lines, blanks lines or commented ones for parse the file ONLY when the parser is working on `QuotationMode.Critical` mode. In that mode, the cited lines are simply skipped, leaving no empty values between records separated by this kind of lines. In other words, if the CSV file holds a record and then some special lines (blank, empty or commented) and then another record, the second record will be saved contiguous to the first record ignoring the lines between both.
6363

6464
>⚠️**Caution**
65-
>{: .text-grey-dk-300 .bg-green-000 }
65+
>{: .text-grey-lt-000 .bg-green-000 }
6666
>If the CSV file has no data, this is the file is an empty one, the `ImportFromCSVstring` method returns an empty array, that is, an array bounded from 0 to -1 and holding no elements and no data.
6767
{: .text-grey-dk-300 .bg-yellow-000 }
6868

docs/api/methods/openconnection.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,12 @@ Loads a CSV file on memory for data Input/Output operations.
4343
_None_
4444

4545
>⚠️**Caution**
46-
>{: .text-grey-dk-300 .bg-green-000 }
46+
>{: .text-grey-lt-000 .bg-green-000 }
4747
>The `OpenConnection` method don't rejects any kind of file extension, user need to ensure the target file has a name ending in `.csv` or `.txt`.
4848
{: .text-grey-dk-300 .bg-yellow-000 }
4949

5050
>📝**Note**
51-
>{: .text-grey-dk-300 .bg-green-000 }
51+
>{: .text-grey-lt-000 .bg-green-000 }
5252
>The `OpenConnection` method is the preamble to the `ImportFromCSV` and `ExportToCSV` methods, this means each call to the citated methods must be preceded by a `OpenConnection` method call.
5353
>After call the `OpenConnection` method is possible to check if the instance is bind to the CSV file, for which is only needed to read the current instance `Connected` property.
5454
{: .text-grey-dk-300 .bg-grey-lt-000 }

docs/api/methods/resettodefault.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ _None_
2626
_None_
2727

2828
>📝**Note**
29-
>{: .text-grey-dk-300 .bg-green-000 }
29+
>{: .text-grey-lt-000 .bg-green-000 }
3030
>Before call the `ResetToDefault` method, user must to check if the target CSV file will be well parsed with the config options shown in the table below.
3131
{: .text-grey-dk-300 .bg-grey-lt-000 }
3232

0 commit comments

Comments
 (0)