sharpcompress
sharpcompress copied to clipboard
adamhathcock
Poor documentation
I don't want to step on the toes of people who share their libraries but the documentation for this library is ... I want to curse but I will be nice.., Terrible. It only shows how to perform basic functions. There is no explanation for anything, and no descriptions of properties/functions for classes. It isn't even built into the library using comments in the code (which is VERY simple to do). If you aren't going to stick to standard descriptive conventions then we need documentation. I just want to parse every file and folder in an archive but there isn't any way that I can tell to get the names of files or their paths within the archive. I have an old version of "SharpCompress" from several years ago and it was very different; far more helpful and useful. I wanted to update my library but this is ridiculous. Previously I used IArchiveEntry which had a FilePath member but the only thing I can find for IArchiveEntry here is a "Key" property. What!!? There is no explanation whatsoever ANYWHERE that I can find about what exactly a "key" is. I have spent HOURS trying to figure this out.
PRs are always welcome with documentation and help. My free time has been limited for years and no one has stepped up.
I don't owe you help.
The least you could have done @primem0ver is to post here how to get to the FilePath using the new Key , to save me some time ...
The least you could have done @primem0ver is to post here how to get to the
FilePathusing the newKey, to save me some time ...
LOL. Why are upset with me? Didn't you read my post? That is MY problem as well. I don't know how to use the Key to get the file path. I haven't worked on the project that I was using this for in a while but eventually I may get back to it... if I can get an answer. That is all I want to know too. As for documentation (@adamhathcock ), I don't mind contributing stuff that I know how to do but documentation files doesn't currently fit in that category. Like you, my time is now currently limited (started my Masters in September, work full time, program part time).