Skip to content

Commit e431963

Browse files
committed
docs(streaming): copywriting on custom transform options
1 parent 8afdc69 commit e431963

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/utilities/streaming.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -95,25 +95,25 @@ We provide popular built-in transformations that you can apply against your stre
9595

9696
### Custom options for data transformations
9797

98-
Each data transformation class accepts additional options to customize the transformation.
98+
We will propagate additional options to the underlying implementation for each transform class.
9999

100-
| Name | Description |
101-
| ----------------- | -------------------------------------------------------------------------------------------------------------- |
102-
| **GzipTransform** | All the options from the [GzipFile constructor](https://docs.python.org/3/library/gzip.html#gzip.GzipFile) |
103-
| **ZipTransform** | All the options from the [ZipFile constructor](https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile) |
104-
| **CsvTransform** | All the options from the [DictReader constructor](https://docs.python.org/3/library/csv.html#csv.DictReader) |
100+
| Name | Available options |
101+
| ----------------- | ------------------------------------------------------------------------------------- |
102+
| **GzipTransform** | [GzipFile constructor](https://docs.python.org/3/library/gzip.html#gzip.GzipFile) |
103+
| **ZipTransform** | [ZipFile constructor](https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile) |
104+
| **CsvTransform** | [DictReader constructor](https://docs.python.org/3/library/csv.html#csv.DictReader) |
105105

106-
For instance, if you want to unzip an S3 object compressed using `LZMA` you could pass that option in the constructor:
106+
For instance, take `ZipTransform`. You can use the `compression` parameter if you want to unzip an S3 object compressed with `LZMA`.
107107

108108
=== "Unzipping LZMA data"
109109

110110
```python hl_lines="12"
111111
--8<-- "examples/streaming/src/s3_transform_lzma.py"
112112
```
113113

114-
Or, if you want to load a `TSV` file, you can just change the delimiter on the `CSV` transform:
114+
Or, if you want to load a tab-separated file (TSV), you can use the `delimiter` parameter in the `CsvTransform`:
115115

116-
=== "Loading TSV data"
116+
=== "Deserializing tab-separated data values"
117117

118118
```python hl_lines="11"
119119
--8<-- "examples/streaming/src/s3_transform_tsv.py"

0 commit comments

Comments
 (0)