Skip to content

Commit a5c4927

Browse files
committed
Update docs
1 parent 38b502b commit a5c4927

File tree

9 files changed

+21
-21
lines changed

9 files changed

+21
-21
lines changed

docs/api/properties/connected.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ nav_order: 2
88
# Connected
99
{: .fs-9 }
1010

11-
Gets the CSV connection status for the current instance.
11+
Gets the CSV/TSV connection status for the current instance.
1212
{: .fs-6 .fw-300 }
1313

1414
---
@@ -33,7 +33,7 @@ _None_
3333

3434
>📝**Note**
3535
>{: .text-grey-lt-000 .bg-green-000 }
36-
>A `False` value from `Connected` property indicates the CSV file is not load in memory.
36+
>A `False` value from `Connected` property indicates the file is not loaded in memory.
3737
{: .text-grey-dk-300 .bg-grey-lt-000 }
3838

3939
[Back to Properties overview](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/)

docs/api/properties/endingrecord.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ _Yes_
3838

3939
>📝**Note**
4040
>{: .text-grey-lt-000 .bg-green-000 }
41-
>The `EndingRecord` property must be used in combination with the `StartingRecord` property for import a certain range of records from a CSV file.
41+
>The `EndingRecord` property must be used in combination with the `StartingRecord` property for import a certain range of records from a CSV/TSV file.
4242
{: .text-grey-dk-300 .bg-grey-lt-000 }
4343

4444
See also
@@ -50,8 +50,8 @@ See also
5050

5151
The `EndingRecord` property can be set to an value greater or equal than zero (0), trying to set it to a negative value will setting the property to its default value.
5252

53-
The default value for the `EndingRecord` property is one(1) and force the class to import all successive records from de CSV file starting at the record specified with the `StartingRecord` property. Setting the `EndingRecord` property to zero (0) and the `StartingRecord` property to one (1) , will import the first record from the CSV file only. Whatever other `EndingRecord` property value less than the given in the `StartingRecord` property forces import one record.
53+
The default value for the `EndingRecord` property is one(1) and force the class to import all successive records from the file starting at the record specified with the `StartingRecord` property. Setting the `EndingRecord` property to zero (0) and the `StartingRecord` property to one (1) , will import the first record from the target file only. Whatever other `EndingRecord` property value less than the given in the `StartingRecord` property forces import one record.
5454

55-
Setting the `EndingRecord` property to a value greater than the available records in the CSV file has the same effect than setting it to one(1).
55+
Setting the `EndingRecord` property to a value greater than the available records in the file has the same effect than setting it to one(1).
5656

5757
[Back to Properties overview](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/)

docs/api/properties/escapetoken.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ _Yes_
3838

3939
>📝**Note**
4040
>{: .text-grey-lt-000 .bg-green-000 }
41-
>Setting the `EscapeToken` property to `EscapeTokens.NullChar` is only recommended when the `QuotingMode` property is set to `QuotationMode.All`. This scenario comes to reality when user have to work with CSV files over which neither fields need to be escaped.
41+
>Setting the `EscapeToken` property to `EscapeTokens.NullChar` is only recommended when the `QuotingMode` property is set to `QuotationMode.All`. This scenario comes to reality when user have to work with files over which neither fields need to be escaped.
4242
>
4343
>The above means if the target file have an unknown structure, the best alternative is set the `EscapeToken` property to `EscapeTokens.DoubleQuotes` and the `QuotingMode` property to `QuotationMode.Critical`. These are the defaults settings.
4444
{: .text-grey-dk-300 .bg-grey-lt-000 }

docs/api/properties/fieldsdelimiter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ nav_order: 9
88
# FieldsDelimiter
99
{: .fs-9 }
1010

11-
Indicates the char that will be used for delimit fields in the target CSV file.
11+
Indicates the char that will be used for delimit fields in the target CSV/TSV file.
1212
{: .fs-6 .fw-300 }
1313

1414
---
@@ -38,7 +38,7 @@ _Yes_
3838

3939
>⚠️**Caution**
4040
>{: .text-grey-lt-000 .bg-green-000 }
41-
>The current behavior for the CSV interface forces `FieldsDelimiter` property to be distinct than a `Space` or`vbTab` char, set the property to comma or semicolon are the most logical options.
41+
>The current behavior for the CSV interface forces `FieldsDelimiter` property to be distinct than a `Space` char, set the property to comma, semicolon or `vbTab`, are the allowable options.
4242
{: .text-grey-dk-300 .bg-yellow-000 }
4343

4444
[Back to Properties overview](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/)

docs/api/properties/fileencoding.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ nav_order: 10
88
# FileEncoding
99
{: .fs-9 }
1010

11-
Returns the charset used to encode the last opened CSV file.
11+
Returns the charset used to encode the last opened CSV/TSV file.
1212
{: .fs-6 .fw-300 }
1313

1414
---
@@ -33,7 +33,7 @@ _None_
3333

3434
>📝**Note**
3535
>{: .text-grey-lt-000 .bg-green-000 }
36-
>The `FileEncoding` property is set when CSV file is load on memory. In other words, the property holds the encoding for the last opened file. All the possible values are shown in this section.
36+
>The `FileEncoding` property is set when the file is loaded to memory. In other words, the property holds the encoding for the last opened file. All the possible values are shown in this section.
3737
{: .text-grey-dk-300 .bg-grey-lt-000 }
3838

3939
<table>
@@ -46,15 +46,15 @@ _None_
4646
<tbody>
4747
<tr>
4848
<td style="text-align: left;"><em>ANSI</em></td>
49-
<td style="text-align: left;">When the last opened CSV file is encoded in ANSI<br> format. Each char is represented using 8 bits.</td>
49+
<td style="text-align: left;">When the last opened file is encoded in ANSI<br> format. Each char is represented using 8 bits.</td>
5050
</tr>
5151
<tr>
5252
<td style="text-align: left;"><em>Unicode</em></td>
53-
<td style="text-align: left;">The last opened CSV file is encoded in Unicode<br> format. Combinations of basic chars are allowed<br> over the CSV file and its takes 2 bytes per<br> character.</td>
53+
<td style="text-align: left;">The last opened file is encoded in Unicode<br> format. Combinations of basic chars are allowed<br> over the file and its takes 2 bytes per<br> character.</td>
5454
</tr>
5555
<tr>
5656
<td style="text-align: left;"><em>UTF-8</em></td>
57-
<td style="text-align: left;">The CSV file is encoded in UTF-8 format.</td>
57+
<td style="text-align: left;">The file is encoded in UTF-8 format.</td>
5858
</tr>
5959
<tr>
6060
<td style="text-align: left;"><em>BigEndian</em></td>

docs/api/properties/filename.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ nav_order: 11
88
# fileName
99
{: .fs-9 }
1010

11-
Gets the file name that corresponds to the last opened CSV file.
11+
Gets the file name that corresponds to the last opened CSV/TSV file.
1212
{: .fs-6 .fw-300 }
1313

1414
---
@@ -33,7 +33,7 @@ _None_
3333

3434
>📝**Note**
3535
>{: .text-grey-lt-000 .bg-green-000 }
36-
>The `fileName` property is set when CSV file is load to memory. This is, the property holds the last opened file’s name.
36+
>The `fileName` property is set when the file is loaded to memory. This is, the property holds the last opened file’s name.
3737
{: .text-grey-dk-300 .bg-grey-lt-000 }
3838

3939
[Back to Properties overview](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/)

docs/api/properties/quotingmode.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ nav_order: 13
88
# QuotingMode
99
{: .fs-9 }
1010

11-
Configures the CSV parsing/writing operation behavior.
11+
Configures the CSV/TSV parsing/writing operation behavior.
1212
{: .fs-6 .fw-300 }
1313

1414
---
@@ -38,7 +38,7 @@ _Yes_
3838

3939
>📝**Note**
4040
>{: .text-grey-lt-000 .bg-green-000 }
41-
>Use the `QuotingMode` property to set the parser behavior. Some CSV files not require further processes after an easy to do string split.
41+
>Use the `QuotingMode` property to set the parser behavior. Some files do not require further processes after an easy to do string split.
4242
{: .text-grey-dk-300 .bg-grey-lt-000 }
4343

4444
See also

docs/api/properties/recordsdelimiter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ nav_order: 14
88
# RecordsDelimiter
99
{: .fs-9 }
1010

11-
Indicates the char that will be used for delimit records in the target CSV file.
11+
Indicates the char that will be used for delimit records in the target CSV/TSV file.
1212
{: .fs-6 .fw-300 }
1313

1414
---
@@ -38,7 +38,7 @@ _Yes_
3838

3939
>📝**Note**
4040
>{: .text-grey-lt-000 .bg-green-000 }
41-
>The `RecordsDelimiter` property can be set to`vbCr`, `vbCrLf` or `vbLf`. This options unlocks a limitation from RFC-4180 CSV specs.
41+
>The `RecordsDelimiter` property can be set to`vbCr`, `vbCrLf` or `vbLf`. This options unlocks a limitation from the RFC-4180 specs.
4242
{: .text-grey-dk-300 .bg-grey-lt-000 }
4343

4444
[Back to Properties overview](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/)

docs/api/properties/startingrecord.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ _Yes_
3838

3939
>📝**Note**
4040
>{: .text-grey-lt-000 .bg-green-000 }
41-
>Use the `StartingRecord` property in combination with the `EndingRecord` property for import a certain range of records from CSV file.
41+
>Use the `StartingRecord` property in combination with the `EndingRecord` property for import a certain range of records from CSV/TSV file.
4242
{: .text-grey-dk-300 .bg-grey-lt-000 }
4343

4444
See also
@@ -48,6 +48,6 @@ See also
4848

4949
The `StartingRecord` property can be set to an value greater or equal than one (1), trying to set it to a value less than the cited one will setting the property to its default value.
5050

51-
The default value for the `StartingRecord` property is one(1) and force the class to start the importation over the first available record in the CSV file. If the `StartingRecord` property is set to a value greater than the available records in the CSV file, neither record will be imported.
51+
The default value for the `StartingRecord` property is one(1) and force the class to start the importation over the first available record in the file. If the `StartingRecord` property is set to a value greater than the available records in the file, neither record will be imported.
5252

5353
[Back to Properties overview](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/)

0 commit comments

Comments
 (0)