diffy icon indicating copy to clipboard operation
diffy copied to clipboard

File/String usage in documentation

Open I3ck opened this issue 4 years ago • 1 comments

Within the documentation most parameters are described as file. But it seems like the parameters are actually strings (at least in many cases).
I think it makes sense to update the documentation accordingly.

I3ck avatar Jul 02 '20 15:07 I3ck

Yes I can see how that would be slightly confusing. The intent of the library is to provide the functionality for diffing/merging files but in order to be more flexible all of the interfaces work on borrowed strings instead of a std::fs::File type. The expected usage would be to first read a file into a String and then use this library. I'll try and make suitable adjustments to the documentation to reflect this

bmwill avatar Jul 06 '20 14:07 bmwill