docs: fix typos etc #666
docs: fix typos etc #666
Conversation
guenthermi
requested review from
LMMilliken,
gmastrapas,
bwanglzu and
scott-martens
In this case it should work because it uses tabs as delimiters right? How to handle commas is already explained here: https://github.com/jina-ai/finetuner/pull/666/files#diff-7396eec4b8628a7cf7461d430efcbdd11c0dc7a2cd1e6864b893817f6cf1a0caR95-R108 |
Co-authored-by: George Mastrapas <32414777+gmastrapas@users.noreply.github.com>
|
It seems like the tabs in the tsv examples have been spaces. This is caused, because many code editors automatically replace tabs with spaces, even in markdown. So if users copied this csv file they did not work. To prevent this, I replaced the tabs with commas. In this way it does not look as nice as before, but the at least it is correct. |
|
|
||
| ```{important} | ||
| If a text field contains commas, it breaks the CSV format since it is interpreted as spanning over multiple columns. | ||
| In this case, please enclose the field in double quotes, such as `field1,"field, 2"`. | ||
| ``` | ||
|
|
||
| We support the following dialects of CSV: | ||
|
|
||
| + `excel` use `,` as delimiter and `\r\n` as lineterminator. | ||
| + `excel-tab` use `\t` as delimiter and `\r\n` as lineterminator. | ||
| + `unix` use `,` as delimiter and `\n` as lineterminator. | ||
|
|
||
| ```{warning} | ||
| Please remove/replace comma in your data fields if you are using a comma `,` as a delimiter. | ||
| Please remove/replace commas in your data fields if you are using a comma `,` as a delimiter. |
There was a problem hiding this comment.
These two hints are saying conflicting things about dealing with commas in CSVs, I think it would be best to remove the warning
Co-authored-by: Scott Martens <70647348+scott-martens@users.noreply.github.com>
|
📝 Docs are deployed on https://ft-docs-fix-typos-etc--jina-docs.netlify.app 🎉 |
Fix typos and duplicate text in docs
I removed the duplicate part in the documentation and fixed a couple of typos and minor wrong formulations.