Add an explanation of the withBom option utility

sonata-project / exporter

Lightweight Exporter library

https://docs.sonata-project.org/projects/exporter

MIT License

439 stars 88 forks source link

Add an explanation of the withBom option utility #487

Closed soullivaneuh closed 2 years ago

soullivaneuh commented 3 years ago

We currently have a withBom option adding some special chars at the beginning of the CSV file: https://github.com/sonata-project/exporter/blob/487a4f31cebe8f12e4ca8c47099c9ef9230108ce/src/Writer/CsvWriter.php#L111-L113

However, we don't know what is the goal of this option.

It would be great to have one explanation sentence on the documentation and/or a documentation links about it.

OskarStark commented 3 years ago

cc @greg0ire

greg0ire commented 3 years ago

This was introduced in #53 , @ThibautAlgrin can you please look into this?

BTW I didn't review that PR, but you did @soullivaneuh :stuck_out_tongue:

More details on what that is can be found here: https://en.wikipedia.org/wiki/Byte_order_mark

github-actions[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.