I'm afraid I don't like this PR much. I definitely appreciate the effort though. :-)

With regard to the _ stuff, I haven't found the time to submit a patch to upstream luacheck to make the specifics configurable, but I don't think changing what's pos everywhere to coords is helpful when reading in the way _pos is. Perhaps coords is a better name, but then logically it should be _coords or coords_ because pos will also have been changed to coords.

And I'm not at all fond of the logic changes either. The dumb algorithm that should keep its stupid mouth shut about which way we decide the logic is most expressive and comprehensible about its intent.

Related: https://github.com/awesomeWM/awesome/issues/3627

I take back what I said about the logic changes. I think those look like improvements in clarity, meaning I think luacheck makes sense there and no global override is necessary in my eyes, only (theoretically) local ones.

Edit: I was mainly responding to the "make luacheck happy" commit message rather than to the actual changes on that one, mea culpa.

Well, when reading first @Frenzie 's comment, I was fearing there would be lots of changes in many of (my) places :)
But it's very limited, so I won't mind.
(I still prefer reading _self than this - with _self, you know it refers to some lua object that might not be the current self. With this, I feel like having a journey into some other language like Javascript or Java :)
May be a one line comment just in readerhighlight.lua above the first use of this saying this will be actually our self here - might help future readers of this bit of code (more popuular than CreDocument)

I'd rather use self_ iff [sic] we decide we want to use the _self style prefix to mark unused.

I'd rather use self_ iff [sic] we decide we want to use the _self style prefix to mark unused.

That would have been my choice if I hadn't already peppered a few this across the codebase ;p.