Plan to have a concrete documentation ?

wmde / Diff

䷂ Library for diffing, patching and representing differences between objects

BSD 3-Clause "New" or "Revised" License

200 stars 15 forks source link

Plan to have a concrete documentation ? #82

Closed Arteneko closed 6 years ago

Arteneko commented 7 years ago

Do you plan to write/generate any comprehensive documentation for, at least, the API (and maybe some more detailed examples) ?

JeroenDeDauw commented 7 years ago

There is no plan for this from my side.

API wise I'm not sure what would be helpful beyond what is already in the README. There are tools such as doxygen that allow you to create HTML documentation from the source, though personally I've always found this kind of documentation inferior to looking at the actual code. Is this what you had in mind?

What examples are you missing at the moment? Definitely feel free to create a pull request that adds some new ones.