Skip to content

Commit

Permalink
Fixed small typos (#69)
Browse files Browse the repository at this point in the history
  • Loading branch information
SmetDenis committed Mar 21, 2024
1 parent 8faf35a commit c2af6f9
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 17 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ csv:
header: true # If the first row is a header. If true, name of each column is required.
delimiter: , # Delimiter character in CSV file.
quote_char: \ # Quote character in CSV file.
enclosure: "\"" # Enclosure for each field in CSV file.
enclosure: '"' # Enclosure for each field in CSV file.
encoding: utf-8 # (Experimental) Only utf-8, utf-16, utf-32.
bom: false # (Experimental) If the file has a BOM (Byte Order Mark) at the beginning.

Expand Down Expand Up @@ -200,8 +200,8 @@ columns:
# Scientific number format is also supported. Example: "1.2e3".
num: 5 # You can use integers.
num_not: 4.123 # Float numbers.
num_min: 1.2e3 # And even scientific format.
num_max: -10.123 # Negative and positive, zero is also supported.
num_min: -10.123 # Negative and positive, zero is also supported.
num_max: 1.2e3 # And even scientific format.
is_int: true # Check format only. Can be negative and positive. Without any separators.
is_float: true # Check format only. Can be negative and positive. Dot as decimal separator.

Expand Down Expand Up @@ -405,10 +405,11 @@ You can find launch examples in the [workflow demo](https://github.com/JBZoo/Csv
```
<!-- /github-actions-yml -->

**Note**. GitHub Actions report format is `table` by default. See [GitHub Actions friendly](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-a-warning-message) and [PR as a live demo](https://github.com/JBZoo/Csv-Blueprint-Demo/pull/1/files).
**Note**. GitHub Actions report format is `table` by default.

This allows you to see bugs in the GitHub interface at the PR level.
That is, the error will be shown in a specific place in the CSV file right in diff of your Pull Requests! [See example](https://github.com/JBZoo/Csv-Blueprint-Demo/pull/1/files).
But you can specify `report: github` to see friendly error output in your PRs using [annotations](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-a-warning-message).
This allows you to see bugs in the GitHub interface at the PR level. See [the PR as a live demo](https://github.com/JBZoo/Csv-Blueprint-Demo/pull/1/files).
That is, the error will be shown in a specific place in the CSV file right in diff of your Pull Requests!

![GitHub Actions - PR](.github/assets/github-actions-pr.png)

Expand Down
4 changes: 2 additions & 2 deletions schema-examples/full.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@

"num" : 5,
"num_not" : 4.123,
"num_min" : 1200,
"num_max" : -10.123,
"num_min" : -10.123,
"num_max" : 1.2e3,
"is_int" : true,
"is_float" : true,

Expand Down
4 changes: 2 additions & 2 deletions schema-examples/full.php
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@

'num' => 5,
'num_not' => 4.123,
'num_min' => 1.2e3,
'num_max' => -10.123,
'num_min' => -10.123,
'num_max' => 1.2e3,
'is_int' => true,
'is_float' => true,

Expand Down
6 changes: 3 additions & 3 deletions schema-examples/full.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ csv:
header: true # If the first row is a header. If true, name of each column is required.
delimiter: , # Delimiter character in CSV file.
quote_char: \ # Quote character in CSV file.
enclosure: "\"" # Enclosure for each field in CSV file.
enclosure: '"' # Enclosure for each field in CSV file.
encoding: utf-8 # (Experimental) Only utf-8, utf-16, utf-32.
bom: false # (Experimental) If the file has a BOM (Byte Order Mark) at the beginning.

Expand Down Expand Up @@ -114,8 +114,8 @@ columns:
# Scientific number format is also supported. Example: "1.2e3".
num: 5 # You can use integers.
num_not: 4.123 # Float numbers.
num_min: 1.2e3 # And even scientific format.
num_max: -10.123 # Negative and positive, zero is also supported.
num_min: -10.123 # Negative and positive, zero is also supported.
num_max: 1.2e3 # And even scientific format.
is_int: true # Check format only. Can be negative and positive. Without any separators.
is_float: true # Check format only. Can be negative and positive. Dot as decimal separator.

Expand Down
4 changes: 2 additions & 2 deletions schema-examples/full_clean.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ columns:
ends_with: " suffix"
num: 5
num_not: 4.123
num_min: 1.2e3
num_max: -10.123
num_min: -10.123
num_max: 1200.0
is_int: true
is_float: true
precision: 5
Expand Down
4 changes: 2 additions & 2 deletions src/Rules/Cell/ComboNum.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ final class ComboNum extends AbstractCellRuleCombo
protected const HELP_OPTIONS = [
self::EQ => ['5', 'You can use integers'],
self::NOT => ['4.123', 'Float numbers'],
self::MIN => ['1.2e3', 'And even scientific format'],
self::MAX => ['-10.123', 'Negative and positive, zero is also supported'],
self::MIN => ['-10.123', 'Negative and positive, zero is also supported'],
self::MAX => ['1.2e3', 'And even scientific format'],
];

private const PRECISION = 10;
Expand Down

0 comments on commit c2af6f9

Please sign in to comment.