(docs) How to upgrade from xkeysnail instructions about keyszer HOT 8 CLOSED

https://github.com/joshgoebel/keyszer/blob/exerted/UPGRADE_FROM_XKEYSNAIL.md

Thoughts?

from keyszer.

@joshgoebel

Instructions on "upgrading" seem pretty thorough. You're really changing a lot.

What about renaming the "ignore_key" to "ignore_combo" since that is what it is actually meant to be applied to, a combo.

from keyszer.

I'm not opposed, you want to make a PR for that? :)

from keyszer.

I see it in transform.py, but it looks like it's imported from elsewhere (an API file?). No, I don't really want to mess with that.

If I'm reading this right, this and pass_through_key are actually dealing with one key at a time in the for loop as the combo is disassembled(?), so I guess it's just a point of view which naming is more confusing from the perspective of someone looking at the code loops or just editing shortcuts in the config file.

        elif command is ignore_key:
            debug("ignore_key", key)
            return True
        elif command is pass_through_key:
            debug("pass_thru_key", key)
            _output.send_key_action(key, action)
            return True

from keyszer.

pass_throught_key is gone now...

but it looks like it's imported from elsewhere

This is what global search and replace is for. :) And you have me reviewing PRs to make sure you don't break anything.

from keyszer.

Is this when condition something that would only be attached to modmaps with just a few key remaps, or is it possible this would be used on a keymap with hundreds of shortcuts? This could be quite annoying/confusing having one part of the information saying what the shortcuts are applying to at the top, and another part at the bottom with many lines in between.

# after
multipurpose_modmap("Microsoft keyboard combos", {
		Key.LEFT_SHIFT: [Key.KPLEFTPAREN, Key.LEFT_SHIFT],
		Key.RIGHT_SHIFT: [Key.KPRIGHTPAREN, Key.RIGHT_SHIFT]
	}, when = lambda ctx: ctx.device_name.startswith("Microsoft")
)

from keyszer.

It's Python... you can specify the arguments in any order IF you use their names, if this really bothered someone they can just put the when = first and then do mappings = to put the mappings after... I think in most cases the description should explain what is happening without a need to read the conditional...

from keyszer.

I'm also open to suggestions but I don't like varying # of arguments with no explanation or a blank None argument...

from keyszer.