docs: make the nature of content clearer

ESSS / pytest-regressions

Pytest plugin for regression testing: https://pytest-regressions.readthedocs.io

MIT License

185 stars 36 forks source link

docs: make the nature of content clearer #153

Closed 12rambau closed 1 year ago

12rambau commented 1 year ago

In the end, the most misleading parameter for me was "binary" as it assumed I pass a file when I should instead pass the content of a file in a format that fits the data (bytes or text).

I updated the docstring to make it a bit clearer IMHO.

Fix #151