[davidfor]

Originally Posted by geek1011

I've mentioned it in bits and pieces scattered around many places. I'll be consolidating it for kepubify v3.


https://www.mobileread.com/forums/sh....php?p=3769235

Now I remember. But, that was a problem that existed in one firmware version that was replaced after three days. If it doesn't fix anything else, it isn't a particularly useful option.

Most are in the command documentation,

I have to disagree with that. I was looking at your page for kepubify when I wrote my post. The lack is what prompted my comments.

some I've removed after the need was gone. You can find the most up-to-date information in: https://github.com/geek1011/kepubify...kepub/kepub.go

Yes, I can read code, but most can't or won't. And nothing in the code tells me why the changes exist. Is it fixing a firmware bug, a book bug, or because that's the way you think it should be.

That's partly the intention. You aren't supposed to notice the fixes unless they are necessary. But, I agree they need to be documented properly. That will be resolved in kepubify v3.

I think documenting the bug workarounds are almost more important than the other things. If we don't know what is being fixed, how do we know what to look for in problems. And this is full of, to me, unexpected side-effects. Nothing hints that you are doing the smarten punctuation. Or the removal of the "Replacement character". Or replacing the unicode non-breaking space with an HTML entity.

Improving the documentation in v3 is a good idea.

And for the record, I'm terrible at documentation and know I write it from the point of view of the developer. I keep hoping someone will point out the problems (missing, unclear, errors or anything) but it rarely happens