Skip to content

Commit

Permalink
update links
Browse files Browse the repository at this point in the history
  • Loading branch information
tilo committed Jul 8, 2024
1 parent 34a530f commit 0e9570f
Show file tree
Hide file tree
Showing 10 changed files with 34 additions and 7 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Or install it yourself as:

* [Introduction](docs/_introduction.md)
* [The Basic API](docs/basic_api.md)
* [Batch Processing](./docs/batch_processing.md)
* [Configuration Options](docs/options.md)
* [Row and Column Separators](docs/row_col_sep.md)
* [Header Transformations](docs/header_transformations.md)
Expand Down
3 changes: 3 additions & 0 deletions docs/_introduction.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
PREVIOUS [README](../README.md) | NEXT: [The Basic API](./basic_api.md)
---------------

# SmarterCSV Introduction

Expand Down Expand Up @@ -39,4 +41,5 @@ The CSV processing also needed to be robust against variations in the input data
* Data Validations
(planned feature)

---------------
PREVIOUS [README](../README.md) | NEXT: [The Basic API](./basic_api.md)
5 changes: 4 additions & 1 deletion docs/basic_api.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
PREVIOUS: [Introduction](./_introduction.md) | NEXT: [Batch Processing](./batch_processing.md)
----------------

# SmarterCSV API

Expand Down Expand Up @@ -139,4 +141,5 @@ $ hexdump -C spec/fixtures/bom_test_feff.csv
end
```

PREVIOUS: [Introduction](./_introduction.md) | NEXT: [Configuration Options](./options.md)
----------------
PREVIOUS: [Introduction](./_introduction.md) | NEXT: [Batch Processing](./batch_processing.md)
5 changes: 4 additions & 1 deletion docs/batch_processing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
PREVIOUS: [The Basic API](./basic_api.md) | NEXT: [Configuration Options](./options.md)
----------------

# Batch Processing

Expand Down Expand Up @@ -50,4 +52,5 @@ and how the `process` method returns the number of chunks when called with a blo
=> returns number of chunks we processed
```


----------------
PREVIOUS: [The Basic API](./basic_api.md) | NEXT: [Configuration Options](./options.md)
4 changes: 4 additions & 0 deletions docs/data_transformations.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
PREVIOUS: [Header Validations](./header_validations.md) | NEXT: [Value Converters](./value_converters.md)
-------------------

# Data Transformations

SmarterCSV automatically transforms the values in each colum in order to normalize the data.
Expand Down Expand Up @@ -31,4 +34,5 @@ By default SmarterCSV uses `remove_empty_hashes: true` to remove these empty has

This can be set to `true`, to keep these empty hashes in the results.

-------------------
PREVIOUS: [Header Validations](./header_validations.md) | NEXT: [Value Converters](./value_converters.md)
5 changes: 4 additions & 1 deletion docs/header_transformations.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
PREVIOUS: [Row and Column Separators](./row_col_sep.md) | NEXT: [Header Validations](./header_validations.md)
---------------

# Header Transformations

By default SmarterCSV assumes that a CSV file has headers, and it automatically normalizes the headers and transforms them into Ruby symbols. You can completely customize or override this (see below).
Expand Down Expand Up @@ -93,6 +96,6 @@ For CSV files with headers, you can either:
* some CSV files use un-escaped quotation characters inside fields. This can cause the import to break. To get around this, use the `:force_simple_split => true` option in combination with `:strip_chars_from_headers => /[\-"]/` . This will also significantly speed up the import.
If you would force a different :quote_char instead (setting it to a non-used character), then the import would be up to 5-times slower than using `:force_simple_split`.


---------------
PREVIOUS: [Row and Column Separators](./row_col_sep.md) | NEXT: [Header Validations](./header_validations.md)

4 changes: 4 additions & 0 deletions docs/header_validations.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
PREVIOUS: [Header Transformations](./header_transformations.md) | NEXT: [Data Transformations](./data_transformations.md)
----------------

# Header Validations

When you are importing data, it can be important to verify that all required data is present, to ensure consistent quality when importing data.
Expand All @@ -17,4 +20,5 @@ If these keys are not present, `SmarterCSV::MissingKeys` will be raised to infor
=> this will raise SmarterCSV::MissingKeys if any row does not contain these three keys
```

----------------
PREVIOUS: [Header Transformations](./header_transformations.md) | NEXT: [Data Transformations](./data_transformations.md)
8 changes: 4 additions & 4 deletions docs/options.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
PREVIOUS: [Batch Processing](./batch_processing.md) | NEXT: [Row and Column Separators](./row_col_sep.md)
-------------

# SmarterCSV Options

Expand Down Expand Up @@ -80,7 +82,5 @@ There have been a lot of 1-offs and feature creep around these options, and goin
| | | also accepts either {:except => [:key1,:key2]} or {:only => :key3} |
---------------------------------------------------------------------------------------------------------------------------------


PREVIOUS: [The Basic API](./basic_api.md) | NEXT: [Row and Column Separators](./row_col_sep.md)


-------------
PREVIOUS: [Batch Processing](./batch_processing.md) | NEXT: [Row and Column Separators](./row_col_sep.md)
3 changes: 3 additions & 0 deletions docs/row_col_sep.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
PREVIOUS: [Configuration Options](./options.md) | NEXT: [Header Transformations](./header_transformations.md)
----------------

# Row and Column Separators

Expand Down Expand Up @@ -86,4 +88,5 @@ In this example, we use `comment_regexp` to filter out and ignore any lines star
=> returns number of chunks
```

----------------
PREVIOUS: [Configuration Options](./options.md) | NEXT: [Header Transformations](./header_transformations.md)
3 changes: 3 additions & 0 deletions docs/value_converters.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
PREVIOUS: [Data Transformations](./data_transformations.md) | UP: [README](../README.md)
--------------------

# Using Value Converters

Expand Down Expand Up @@ -50,4 +52,5 @@ If you use `key_mappings` and `value_converters`, make sure that the value conve
=> Float
```

--------------------
PREVIOUS: [Data Transformations](./data_transformations.md) | UP: [README](../README.md)

0 comments on commit 0e9570f

Please sign in to comment.